splineops 0.0.0__tar.gz

splineops-0.0.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,45 @@
+# splineops/.github/workflows/deploy-docs.yml
+name: Deploy Sphinx Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install documentation requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[docs]
+
+      - name: Build Sphinx documentation
+        run: make -C docs html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          external_repository: splineops/splineops.github.io
+          publish_branch: main
+          publish_dir: docs/_build/html

splineops-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,102 @@
+# splineops/.github/workflows/release.yml
+name: Build & publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write  # OIDC for PyPI
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      # macOS only: try to install libomp. Non-fatal if it fails.
+      - name: (macOS) Try to install libomp (non-fatal)
+        if: matrix.os == 'macos-latest'
+        run: |
+          if command -v brew >/dev/null 2>&1; then
+            brew list libomp >/dev/null 2>&1 || brew install libomp || true
+          else
+            echo "Homebrew not available; building without libomp."
+          fi
+
+      - name: Install cibuildwheel
+        run: python -m pip install -U pip cibuildwheel build
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir dist
+        env:
+          # CPython only, for versions we support
+          CIBW_BUILD: "cp310-* cp311-* cp312-*"
+
+          # Avoid unsupported/undesired targets
+          # - remove pp* warning by not listing it
+          # - skip musllinux explicitly (we don't ship those)
+          CIBW_SKIP: "*musllinux*"
+
+          # Limit architectures to where SciPy wheels exist & what we support
+          CIBW_ARCHS_LINUX: "x86_64"
+          CIBW_ARCHS_WINDOWS: "AMD64"
+          # macOS: leave default ("auto") or pin to arm64; arm64 is safest on Apple Silicon runners
+          CIBW_ARCHS_MACOS: "arm64"
+
+          # Simple smoke test: import and check native module presence
+          CIBW_TEST_COMMAND: >
+            python -c "import importlib.util, numpy as np, splineops;
+            print('ok', importlib.util.find_spec('splineops._lsresize') is not None)"
+
+      # Build sdist only once (Ubuntu)
+      - name: Build sdist (once on Ubuntu)
+        if: matrix.os == 'ubuntu-latest'
+        run: python -m build -s -o dist
+
+      # Upload wheels for this OS (unique name per matrix instance)
+      - name: Upload wheel artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: dist/*.whl
+          if-no-files-found: error
+
+      # Upload sdist only from Ubuntu
+      - name: Upload sdist artifact
+        if: matrix.os == 'ubuntu-latest'
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  publish:
+    needs: [build_wheels]
+    runs-on: ubuntu-latest
+    steps:
+      # Download all wheel artifacts from all OSes & the sdist, merged into ./dist
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

splineops-0.0.0/.github/workflows/test.yml

@@ -0,0 +1,57 @@
+# splineops/.github/workflows/test.yml
+name: Test Library
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install tox
+        run: python -m pip install --upgrade pip tox
+
+      # Build the package once (creates .pkg wheel) with C++ enabled
+      - name: Create tox env (build extension) — C++ path
+        env:
+          SPLINEOPS_ACCEL: always
+          OMP_NUM_THREADS: 1
+          OPENBLAS_NUM_THREADS: 1
+          MKL_NUM_THREADS: 1
+          NUMEXPR_NUM_THREADS: 1
+        run: tox -e py --notest
+
+      # Smoke check *inside the tox env* (no pytest! just the smoke env)
+      - name: Smoke check native extension (inside tox env)
+        env:
+          SPLINEOPS_ACCEL: always
+        run: tox -q -e smoke
+
+      # Run full test suite (C++ required)
+      - name: Run tests with tox (C++ required)
+        env:
+          SPLINEOPS_ACCEL: always
+          OMP_NUM_THREADS: 1
+          OPENBLAS_NUM_THREADS: 1
+          MKL_NUM_THREADS: 1
+          NUMEXPR_NUM_THREADS: 1
+        run: tox -e py

splineops-0.0.0/.gitignore

@@ -0,0 +1,179 @@
+# JetBrains
+.idea/
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Environments
+splineops_env/
+
+# Tex files
+*.aux
+*.fdb_latexmk
+*.fls
+*.synctex.gz
+*.pdf
+
+# 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/
+splineops-env
+
+# 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.0.0/CMakeLists.txt

@@ -0,0 +1,53 @@
+# splineops/CMakeLists.txt
+cmake_minimum_required(VERSION 3.20)
+project(splineops_native LANGUAGES CXX)
+
+option(LSRESIZE_USE_OPENMP "Enable OpenMP for parallel loops" ON)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+if (MSVC)
+  add_compile_options(/W4 /permissive- /Zc:preprocessor /Zc:__cplusplus)
+else()
+  add_compile_options(-Wall -Wextra -Wpedantic)
+endif()
+
+# Let pybind11 find the matching Python
+set(PYBIND11_FINDPYTHON ON)
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(pybind11 CONFIG REQUIRED)
+
+if (LSRESIZE_USE_OPENMP)
+  find_package(OpenMP QUIET)
+endif()
+
+# ---- Absolute source paths (robust on Windows) ----
+set(LSRESIZE_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/cpp/lsresize/src")
+set(PYBIND_DIR       "${CMAKE_CURRENT_SOURCE_DIR}/cpp/pybind")
+
+add_library(lsresize STATIC
+  "${LSRESIZE_SRC_DIR}/filters.cpp"
+  "${LSRESIZE_SRC_DIR}/resize1d.cpp"
+  "${LSRESIZE_SRC_DIR}/resizend.cpp"
+)
+target_include_directories(lsresize PUBLIC "${LSRESIZE_SRC_DIR}")
+target_compile_features(lsresize PUBLIC cxx_std_17)
+if (OpenMP_CXX_FOUND)
+  target_link_libraries(lsresize PUBLIC OpenMP::OpenMP_CXX)
+  target_compile_definitions(lsresize PUBLIC LSRESIZE_WITH_OPENMP=1)
+endif()
+
+pybind11_add_module(_lsresize
+  "${PYBIND_DIR}/_lsresize_bindings.cpp"
+)
+target_link_libraries(_lsresize PRIVATE lsresize)
+
+install(TARGETS _lsresize
+        LIBRARY DESTINATION splineops
+        RUNTIME DESTINATION splineops
+        ARCHIVE DESTINATION splineops)
+
+message(STATUS "OpenMP enabled: " $<BOOL:${OpenMP_CXX_FOUND}>)

splineops-0.0.0/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.0.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.2
+Name: splineops
+Version: 0.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
+Requires-Dist: requests>=2.32.3
+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"
+Requires-Dist: jupyterlite-sphinx>=0.16; extra == "docs"
+Requires-Dist: jupyterlite-pyodide-kernel>=0.4; extra == "docs"
+Description-Content-Type: text/markdown
+
+<!-- splineops/README.md -->
+
+# SplineOps: Spline Operations
+
+See https://splineops.github.io/ for the documentation.
+
+`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 requests
+```
+
+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`, `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.