splineops 0.3.4__tar.gz

splineops-0.3.4/.gitignore

@@ -0,0 +1,168 @@
+# JetBrains
+.idea/
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/_contents/
+docs/sg_execution_times.rst
+docs/auto_examples/
+docs/gen_modules/
+docs/notebooks_binder/
+docs/notebooks_jupyterlite/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

splineops-0.3.4/LICENSE

@@ -0,0 +1,30 @@
+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.

splineops-0.3.4/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.3
+Name: splineops
+Version: 0.3.4
+Summary: Spline signal processing in N-D with support for GPU computing.
+Project-URL: download, https://github.com/splineops/splineops.git
+Project-URL: homepage, https://splineops.github.io/
+Author: Dimitris Perdios, Pablo Garcia-Amorena
+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.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.26
+Requires-Dist: scipy>=1.11
+Provides-Extra: dev
+Requires-Dist: cupy>=12.2; extra == 'dev'
+Requires-Dist: hatch>=1.9; extra == 'dev'
+Requires-Dist: ipython>=8.26; extra == 'dev'
+Requires-Dist: matplotlib>=3.8; extra == 'dev'
+Requires-Dist: pooch>=1.8; extra == 'dev'
+Requires-Dist: pytest>=6.0; extra == 'dev'
+Requires-Dist: tox>=4.13; extra == 'dev'
+Provides-Extra: dev-cupy
+Requires-Dist: black>=23.10; extra == 'dev-cupy'
+Requires-Dist: cupy>=12.2; extra == 'dev-cupy'
+Requires-Dist: hatch>=1.9; extra == 'dev-cupy'
+Requires-Dist: ipython>=8.26; extra == 'dev-cupy'
+Requires-Dist: matplotlib>=3.8; extra == 'dev-cupy'
+Requires-Dist: mypy>=1.8; extra == 'dev-cupy'
+Requires-Dist: pooch>=1.8; extra == 'dev-cupy'
+Requires-Dist: pytest>=6.0; extra == 'dev-cupy'
+Requires-Dist: tox>=4.13; extra == 'dev-cupy'
+Provides-Extra: docs
+Requires-Dist: ipython>=8.26; extra == 'docs'
+Requires-Dist: jupyterlite-pyodide-kernel>=0.4; extra == 'docs'
+Requires-Dist: jupyterlite-sphinx>=0.16; extra == 'docs'
+Requires-Dist: matplotlib>=3.8; extra == 'docs'
+Requires-Dist: myst-parser>=3.0; extra == 'docs'
+Requires-Dist: pooch>=1.8; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme>=0.15; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
+Requires-Dist: sphinx-design>=0.6; extra == 'docs'
+Requires-Dist: sphinx-gallery>=0.17; extra == 'docs'
+Requires-Dist: sphinx-prompt>=1.8; extra == 'docs'
+Requires-Dist: sphinx-remove-toctrees>=1.0; extra == 'docs'
+Requires-Dist: sphinx>=7.3; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: hatch>=1.9; extra == 'tests'
+Requires-Dist: pytest>=6.0; extra == 'tests'
+Requires-Dist: tox>=4.13; extra == 'tests'
+Provides-Extra: visualization
+Requires-Dist: ipython>=8.26; extra == 'visualization'
+Requires-Dist: matplotlib>=3.8; extra == 'visualization'
+Requires-Dist: pooch>=1.8; extra == 'visualization'
+Description-Content-Type: text/markdown
+
+# SplineOps: Spline Operations
+
+SplineOps is a Python-based N-dimensional signal processing library with
+support for GPU computing.
+
+## Installation
+
+Install minimal dependencies in a dedicated environment
+(shown here using [Mamba](https://mamba.readthedocs.io/en/latest/)).
+
+Create and activate your environment
+
+```shell
+mamba create -n myenv
+mamba activate myenv
+```
+
+Make sure you have the conda-forge channel added to your conda configuration.
+If not, you can add it using
+
+```shell
+conda config --add channels conda-forge
+```
+
+Minimal requirements:
+
+```shell
+mamba install numpy scipy
+```
+
+Simply install `splineops` from its wheel using `pip`.
+*IMPORTANT:*
+Not yet uploaded on pypi or anaconda/mamba.
+A wheel is needed and can be obtained from the source (see Packaging below)
+
+```shell
+pip install splineops
+```
+
+To run the examples, `matplotlib`, `pooch` (for built-in image datasets)
+and `IPython` (for Python UI widgets) will also be required.
+
+```shell
+mamba install matplotlib pooch IPython
+```
+
+## Formatting, type checking, and testing
+
+Formatting and type checking is performed using the following commands
+
+```shell
+tox -e format
+tox -e type
+```
+
+Testing requires a valid environment with a supported Python version and `tox`
+installed. Tests can be run with the following command (automatic pick of the
+Python version).
+
+```shell
+tox
+```
+
+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
+
+Easiest way to install dev dependencies
+
+```shell
+mamba install numpy scipy matplotlib pooch IPython black mypy tox hatch pytest
+```
+
+Install `splineops` development environment in editable mode
+
+```shell
+pip install -e .[dev]
+```
+
+## GPU compatibility
+
+You can use SplineOps with `cupy`. If a specific CUDA version is required do
+
+```shell
+mamba 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
+mamba install cupy cutensor cudnn nccl
+```
+
+## Building the documentation
+
+To build the Sphinx documentation, install `splineops` doc dependencies
+
+```shell
+mamba install numpy scipy matplotlib pooch IPython sphinx sphinx-gallery sphinx-prompt sphinx-copybutton sphinx-remove-toctrees pydata-sphinx-theme sphinx-design myst-parser jupyterlite-sphinx jupyterlite-pyodide-kernel
+```
+
+Install `splineops` doc environment in editable mode
+
+```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.
+
+If you want to make a "clean" build, go to `docs` and manually delete the folders `_build`, `auto_examples`, `gen_modules`, `notebooks_jupyterlite` 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.

splineops-0.3.4/README.md

@@ -0,0 +1,151 @@
+# SplineOps: Spline Operations
+
+SplineOps is a Python-based N-dimensional signal processing library with
+support for GPU computing.
+
+## Installation
+
+Install minimal dependencies in a dedicated environment
+(shown here using [Mamba](https://mamba.readthedocs.io/en/latest/)).
+
+Create and activate your environment
+
+```shell
+mamba create -n myenv
+mamba activate myenv
+```
+
+Make sure you have the conda-forge channel added to your conda configuration.
+If not, you can add it using
+
+```shell
+conda config --add channels conda-forge
+```
+
+Minimal requirements:
+
+```shell
+mamba install numpy scipy
+```
+
+Simply install `splineops` from its wheel using `pip`.
+*IMPORTANT:*
+Not yet uploaded on pypi or anaconda/mamba.
+A wheel is needed and can be obtained from the source (see Packaging below)
+
+```shell
+pip install splineops
+```
+
+To run the examples, `matplotlib`, `pooch` (for built-in image datasets)
+and `IPython` (for Python UI widgets) will also be required.
+
+```shell
+mamba install matplotlib pooch IPython
+```
+
+## Formatting, type checking, and testing
+
+Formatting and type checking is performed using the following commands
+
+```shell
+tox -e format
+tox -e type
+```
+
+Testing requires a valid environment with a supported Python version and `tox`
+installed. Tests can be run with the following command (automatic pick of the
+Python version).
+
+```shell
+tox
+```
+
+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
+
+Easiest way to install dev dependencies
+
+```shell
+mamba install numpy scipy matplotlib pooch IPython black mypy tox hatch pytest
+```
+
+Install `splineops` development environment in editable mode
+
+```shell
+pip install -e .[dev]
+```
+
+## GPU compatibility
+
+You can use SplineOps with `cupy`. If a specific CUDA version is required do
+
+```shell
+mamba 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
+mamba install cupy cutensor cudnn nccl
+```
+
+## Building the documentation
+
+To build the Sphinx documentation, install `splineops` doc dependencies
+
+```shell
+mamba install numpy scipy matplotlib pooch IPython sphinx sphinx-gallery sphinx-prompt sphinx-copybutton sphinx-remove-toctrees pydata-sphinx-theme sphinx-design myst-parser jupyterlite-sphinx jupyterlite-pyodide-kernel
+```
+
+Install `splineops` doc environment in editable mode
+
+```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.
+
+If you want to make a "clean" build, go to `docs` and manually delete the folders `_build`, `auto_examples`, `gen_modules`, `notebooks_jupyterlite` 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.

splineops-0.3.4/pyproject.toml

@@ -0,0 +1,99 @@
+# https://learn.scientific-python.org/development/guides/packaging-simple/
+
+[build-system]
+requires = [
+    "hatchling",
+    "hatch-vcs",
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "splineops"
+description = "Spline signal processing in N-D with support for GPU computing."
+readme = "README.md"
+license.file = "LICENSE"
+authors = [
+    { name = "Dimitris Perdios" },
+    { name = "Pablo Garcia-Amorena" },
+]
+dynamic = ["version"]
+requires-python = ">=3.10"
+dependencies = [
+    "numpy >=1.26",
+    "scipy >=1.11",
+]
+classifiers = [
+    "Topic :: Scientific/Engineering",
+    "Intended Audience :: Science/Research",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+urls.download = "https://github.com/splineops/splineops.git"
+urls.homepage = "https://splineops.github.io/"
+
+[project.optional-dependencies]
+visualization = [
+    "matplotlib >=3.8",
+    "pooch >= 1.8",
+    "IPython >= 8.26",
+]
+tests = [
+    "tox >=4.13",
+    "hatch >=1.9",
+    "pytest >=6.0",
+]
+dev_cupy = [
+    "splineops[dev]",
+    "black >=23.10",
+    "mypy >=1.8",
+]
+dev = [
+    "splineops[visualization]",
+    "splineops[tests]",
+    "cupy >=12.2",
+]
+docs = [
+    "splineops[visualization]",
+    "sphinx >=7.3",
+    "sphinx-gallery >=0.17",
+    "sphinx-prompt >=1.8",
+    "sphinx-copybutton >=0.5",
+    "sphinx-remove-toctrees >=1.0",
+    "sphinx-design >=0.6",
+    "pydata-sphinx-theme >=0.15",
+    "myst-parser >= 3.0",
+    "jupyterlite-sphinx >= 0.16",
+    "jupyterlite-pyodide-kernel >= 0.4",
+]
+
+# Hatch tool: dynamic version from git
+[tool.hatch.version]
+source = "vcs"
+
+# Hatch build
+[tool.hatch.build]
+exclude = [
+    "/docs",
+    "/tests",
+    "/examples",
+]
+#include = [
+#    "/src",
+#]
+packages = [
+    "src/splineops",
+]
+
+# Tests: pytest config
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
+xfail_strict = true
+filterwarnings = ["error"]
+log_cli_level = "info"
+testpaths = [
+  "tests",
+]

splineops-0.3.4/splineops/__init__.py

@@ -0,0 +1,3 @@
+import importlib.metadata
+
+__version__ = importlib.metadata.version("splineops")