Merge branch 'main' into enhance_sliding_dot_product

Author: NimaSarajpoor

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    .venv/*
+    .pixi/*

.gitignore

@@ -7,7 +7,7 @@
 .pytest_cache
 LOG*
 PID
-.coverage*
+.coverage
 coverage.json
 coverage.stumpy.json
 dask-worker-space
@@ -22,3 +22,6 @@ docs/_build
 .directory
 test.py
 *.nbconvert.ipynb
+.pixi
+pixi.lock
+uv.lock

README.rst

@@ -200,18 +200,30 @@ Supported Python and NumPy versions are determined according to the `NEP 29 depr
 Where to get it
 ---------------
 
-Conda install (preferred):
+conda:
 
 .. code:: bash
     
     conda install -c conda-forge stumpy
 
-PyPI install, presuming you have numpy, scipy, and numba installed: 
+pip:
 
 .. code:: bash
 
     python -m pip install stumpy
 
+pixi:
+
+.. code:: bash
+
+    pixi add stumpy
+
+uv:
+
+.. code:: bash
+
+    uv add stumpy
+
 To install stumpy from source, see the instructions in the `documentation <https://stumpy.readthedocs.io/en/latest/install.html>`__.
 
 -------------

docs/api.rst

@@ -1,6 +1,6 @@
-==========
-STUMPY API
-==========
+=============
+API Reference
+=============
 
 Have A Question?
 ================

docs/motivation.rst docs/background.rstdocs/motivation.rst renamed to docs/background.rst

@@ -1,6 +1,6 @@
------------------------
-Background & Motivation
------------------------
+----------
+Background
+----------
 
 The following video provides the background and motivation for developing and open sourcing STUMPY:
 

docs/conf.py

@@ -109,6 +109,7 @@
 # documentation.
 #
 html_theme_options = {
+    "header_links_before_dropdown": 7,
     "icon_links": [
         {
             "name": "GitHub",
@@ -144,7 +145,9 @@
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
-# html_sidebars = {}
+# html_sidebars = {
+#     "**": []
+# }
 
 
 # -- Options for HTMLHelp output ---------------------------------------------

docs/help.rst

@@ -1,5 +1,5 @@
-------------
-Getting Help
-------------
+----
+Help
+----
 
-First, please check the `discussions <https://github.com/stumpy-dev/stumpy/discussions>`__ and `issues <https://github.com/stumpy-dev/stumpy/issues?utf8=%E2%9C%93&q=>`__ on Github to see if your question has already been answered there. If no solution is available there feel free to open a new discussion or issue and the authors will attempt to respond in a reasonably timely fashion.
+First, please check the `discussions <https://github.com/stumpy-dev/stumpy/discussions>`__ and `issues <https://github.com/stumpy-dev/stumpy/issues?utf8=%E2%9C%93&q=>`__ on Github to see if your question has already been answered there. If no solution is available there feel free to open a new discussion or issue and the developers will usually respond in a reasonable and timely fashion.

docs/index.rst

@@ -6,11 +6,11 @@ STUMPY documentation
    :maxdepth: 2
    :caption: Contents:
 
-   motivation
-   install
+   background
+   Install <install>
    api
    tutorials
-   Contribute.ipynb
+   Contribute <Contribute.ipynb>
    help
 
 .. include:: ../README.rst

docs/install.rst

@@ -4,21 +4,32 @@ Installation
 
 Supported Python and NumPy versions are determined according to the `NEP 29 deprecation policy <https://numpy.org/neps/nep-0029-deprecation_policy.html>`__.
 
-Using conda/pip
+Where to get it
 ===============
 
-Conda install (preferred):
+conda:
 
 .. code:: bash
 
     conda install -c conda-forge stumpy
 
-PyPI install with ``pip``:
+pip:
 
 .. code:: bash
 
     python -m pip install stumpy
 
+pixi:
+
+.. code:: bash
+
+    pixi add stumpy
+
+uv:
+
+.. code:: bash
+
+    uv add stumpy
 
 From source
 ===========
@@ -30,20 +41,30 @@ To install stumpy from source, first clone the source repository:
     git clone https://github.com/stumpy-dev/stumpy.git
     cd stumpy
 
-Next, you'll need to install the necessary dependencies. For maximum performance (or if you are installing stumpy for the Apple M1 ARM-based chip), it is recommended that you install all dependencies using `conda`:
+Next, you'll need to install the necessary dependencies:
+
+conda:
 
 .. code:: bash
 
-    conda install -c conda-forge -y numpy scipy numba
+    conda install -c conda-forge -y --file requirements.txt
+    python -m pip install .
 
-Alternatively, but with lower performance, you can also install these dependencies using the requirements.txt file in the root of this repository:
+pip:
 
 .. code:: bash
 
     python -m pip install -r requirements.txt
+    python -m pip install .
 
-Once the dependencies are installed (stay inside of the ``stumpy`` directory), execute:
+pixi:
 
 .. code:: bash
 
-    python -m pip install .
+    pixi install
+
+uv:
+
+.. code:: bash
+
+    uv sync