Metadata-Version: 2.2
Name: splineops
Version: 1.0.0
Summary: Spline signal processing in N-D with support for GPU computing.
Author: Dimitris Perdios, Pablo Garcia-Amorena, Philippe Thévenaz
License: BSD 3-Clause License
         
         Copyright (c) 2024, splineops
         Copyright (c) 2023-2024, EPFL (Dimitris Perdios, Pablo Garcia-Amorena)
         Copyright (c) 2021-2022, EPFL (Dimitris Perdios)
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Homepage, https://splineops.github.io/
Project-URL: Source, https://github.com/splineops/splineops
Project-URL: Issues, https://github.com/splineops/splineops/issues
Project-URL: Download, https://github.com/splineops/splineops.git
Requires-Python: >=3.10
Requires-Dist: numpy>=1.26
Requires-Dist: scipy>=1.15
Requires-Dist: matplotlib>=3.8
Provides-Extra: visualization
Requires-Dist: pooch>=1.8; extra == "visualization"
Requires-Dist: IPython>=8.26; extra == "visualization"
Provides-Extra: tests
Requires-Dist: tox>=4.13; extra == "tests"
Requires-Dist: pytest>=6.0; extra == "tests"
Provides-Extra: dev
Requires-Dist: splineops[tests,visualization]; extra == "dev"
Requires-Dist: black>=23.10; extra == "dev"
Requires-Dist: mypy>=1.8; extra == "dev"
Requires-Dist: build; extra == "dev"
Provides-Extra: dev-cupy
Requires-Dist: splineops[dev]; extra == "dev-cupy"
Requires-Dist: cupy>=12.2; extra == "dev-cupy"
Provides-Extra: docs
Requires-Dist: splineops[visualization]; extra == "docs"
Requires-Dist: sphinx>=7.3; extra == "docs"
Requires-Dist: sphinx-gallery>=0.17; extra == "docs"
Requires-Dist: sphinx-prompt>=1.8; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-remove-toctrees>=1.0; extra == "docs"
Requires-Dist: sphinx-design>=0.6; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
Requires-Dist: myst-parser>=3.0; extra == "docs"
Description-Content-Type: text/markdown

<!-- splineops/README.md -->

# SplineOps: Spline Operations

`splineops` is a Python-based N-dimensional signal-processing library with
support for GPU computing.

## Installation

You need at least `Python 3.10` to install `splineops` (ideally `Python 3.12`). `Python 3.11` is also compatible.

Create and activate your Python virtual environment (on Unix or MacOS)

```shell
python -m venv splineops-env
source splineops-env/bin/activate
```

On Windows,

```shell
python -m venv splineops-env
.splineops-env/Scripts/Activate
```

To deactivate the environment use

```shell
deactivate
```

Minimal requirement:

```shell
pip install numpy scipy matplotlib
```

Simply install `splineops` using `pip`

```shell
pip install splineops
```

## Formatting, Type Checking, and Testing

Formatting and type checking is performed as

```shell
tox -e format
tox -e type
```

The testing requires a valid environment with a supported Python version and `tox`
installed. The tests are run with the following command (automatic pick of the
Python version)

```shell
tox
```

The tests can also be launched for a specific Python version (must match the one
installed in the active environment)

```shell
tox -e py310
tox -e py311
tox -e py312
```

*IMPORTANT:* Since CI is not implemented, make sure to run, pass, and/or fix
`tox -e format`, `tox -e type`, and `tox`.

## Packaging

Using `tox` (preferred)

```shell
tox -e build
```

Using `hatch`

```shell
hatch build -t wheel
```

## Development Environment

Install `splineops` development environment in editable mode

```shell
pip install -e .[dev]
```

## GPU Compatibility

You can benefit of `cupy` to deploy `splineops`. If a specific CUDA version is required, do

```shell
pip install cupy cuda-version=12.3
```

Install `splineops` cupy development environment in editable mode

```shell
pip install -e .[dev_cupy]
```

Potential other CuPy libraries
([CuPy from Conda-Forge](https://docs.cupy.dev/en/stable/install.html#installing-cupy-from-conda-forge))

```shell
pip install cupy cutensor cudnn nccl
```

## Building of the Documentation

To build the Sphinx documentation, install `splineops` doc dependencies

```shell
pip install -e .[docs]
```

Navigate to the `docs` directory and run the `make html` command

```shell
cd docs
make html
```

Then, go to `docs/_build/html` and open `index.html` to navigate the
documentation locally.

### Troubleshooting

If you want to make a "clean" build, go to `docs` and manually delete the folders `_build`, `auto_examples`, `gen_modules`, and the file `sg_execution_times.rst`.
Why isn't this done automatically? Because Sphinx optimizes speed and removes redundant tasks, by not re-creating the examples notebooks if they have already been created.
If you, for example, modify the name of the examples files, you will have to delete at least the folder `auto_examples`. Otherwise, the old examples files will not have disappeared automatically and Sphinx will raise an internal warning referring to a toctree.