convinterp 0.1.0__tar.gz → 0.2.0__tar.gz

{convinterp-0.1.0 → convinterp-0.2.0}/.github/workflows/CI.yml

@@ -12,9 +12,13 @@ on:
       - master
     tags:
       - '*'
+    paths-ignore:
+      - 'docs/**'                    # documentation-only changes don't need new wheels
   pull_request:
+    paths-ignore:
+      - 'docs/**'
   workflow_dispatch:
-
+  
 permissions:
   contents: read
 

convinterp-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+# Builds the documentation website from docs/ and publishes it to https://convinterp.org.
+# The code cells run against convinterp compiled from this repository, so the pages always
+# describe the code as it is on main.
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:                 # a "Run workflow" button in the Actions tab
+
+permissions:
+  contents: read
+  pages: write                       # to publish to GitHub Pages
+  id-token: write                    # to authenticate the publishing
+
+concurrency:
+  group: pages                       # one publication at a time; a newer push waits for the current one
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install convinterp from this repository, and the packages the pages use
+        run: |
+          python -m pip install --upgrade pip
+          pip install . jupyter matplotlib scipy sympy
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+      - name: Render the website
+        run: quarto render docs
+      - name: Upload the website
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{convinterp-0.1.0 → convinterp-0.2.0}/.gitignore

@@ -8,4 +8,7 @@ __pycache__/
 *.pyd
 *.pdb
 *.so
-check_python.py
+check_python.py
+# documentation build output (published by CI, never committed)
+docs/_site/
+docs/.quarto/

convinterp-0.2.0/CITATION.cff

@@ -0,0 +1,26 @@
+cff-version: 1.2.0
+message: "If you use convinterp in your work, please cite it as below."
+type: software
+title: "convinterp: high-order convolution interpolation, derivatives and integrals on uniform grids"
+authors:
+  - given-names: Nikolaj Maack
+    family-names: Bielefeld
+    orcid: "https://orcid.org/0009-0005-4385-6444"
+abstract: >-
+  convinterp interpolates data on uniform grids in any number of dimensions, and differentiates
+  and integrates the interpolant exactly, with piecewise-polynomial convolution kernels of up to
+  7th-order accuracy, evaluated in a compiled Rust core. It is a port of the Julia package
+  ConvolutionInterpolations.jl by the same author, and is tested against it.
+license: MIT
+version: 0.2.0
+date-released: 2026-09-26
+doi: "10.5281/zenodo.22972816"
+url: "https://convinterp.org"
+repository-code: "https://github.com/NikoBiele/convinterp"
+keywords:
+  - interpolation
+  - convolution
+  - derivatives
+  - integration
+  - numerical methods
+  - scientific computing

{convinterp-0.1.0 → convinterp-0.2.0}/Cargo.lock

@@ -16,7 +16,7 @@ checksum = "95832e849adfb21180ccb6826a99da14e5d266ae5c2e668e1602cf234f153797"
 
 [[package]]
 name = "convinterp"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "numpy",
  "pyo3",

{convinterp-0.1.0 → convinterp-0.2.0}/Cargo.toml

@@ -1,7 +1,7 @@
 # The Rust package. Cargo is Rust's build tool and package manager, like Julia's Pkg.
 [package]
 name = "convinterp"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"                  # the Rust language edition (a stable set of language rules)
 description = "Rust core of convinterp: high-order convolution interpolation on uniform grids"
 license = "MIT"

{convinterp-0.1.0 → convinterp-0.2.0}/PKG-INFO

@@ -1,17 +1,20 @@
 Metadata-Version: 2.4
 Name: convinterp
-Version: 0.1.0
+Version: 0.2.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Dist: numpy
+Requires-Dist: sympy ; extra == 'derivation'
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: juliacall ; extra == 'test'
+Requires-Dist: sympy ; extra == 'test'
+Provides-Extra: derivation
 Provides-Extra: test
 License-File: LICENSE
-Summary: High-order convolution interpolation and derivatives on uniform grids in any dimension, with a Rust core
+Summary: High-order convolution interpolation, derivatives and integrals on uniform grids in any dimension, with a Rust core
 Keywords: interpolation,convolution,derivatives,numerical methods,scientific computing
 Author: Nikolaj Maack Bielefeld
 License-Expression: MIT
@@ -24,14 +27,18 @@ Project-URL: Repository, https://github.com/NikoBiele/convinterp
 # convinterp
 
 High-order convolution interpolation on uniform grids in any number of dimensions, with
-derivatives, for Python. The core is written in Rust; the kernels are exact polynomials.
+derivatives and integrals, for Python. The core is written in Rust; the kernels are exact
+polynomials.
 
 convinterp is a port of the Julia package
 [ConvolutionInterpolations.jl](https://github.com/NikoBiele/ConvolutionInterpolations.jl), by the
 same author, and is tested against it.
 
-**Status: alpha.** Interpolation and derivatives on uniform grids work in any dimension.
-Integrals and scattered data are coming.
+**Documentation: [convinterp.org](https://convinterp.org)**, with a user guide and accuracy and
+speed comparisons with SciPy.
+
+**Status: alpha.** Interpolation, derivatives and integrals on uniform grids work in any
+dimension. Scattered data are coming.
 
 ## Installation
 
@@ -54,6 +61,10 @@ print(itp(1.0))                                         # ≈ sin(1) = 0.841471
 d_itp = convolution_interpolation(x, np.sin(x), derivative=1)
 print(d_itp(1.0))                                       # ≈ cos(1) = 0.540302
 
+# integrals: a negative order, zero at the first knot x[0] = 0
+i_itp = convolution_interpolation(x, np.sin(x), derivative=-1)
+print(i_itp(1.0))                                       # ≈ 1 − cos(1) = 0.459698
+
 # 2D: one knot array per axis, and data whose axis d runs along knots[d]
 y = np.linspace(0.0, 1.0, 30)                           # knots of the second axis
 data = np.sin(x)[:, None] * np.exp(y)[None, :]          # sin(x)·exp(y) on the 50 × 30 grid
@@ -75,12 +86,12 @@ print(itp2(xs, ys).shape)                               # (3, 4)
 `kernel="auto"` (the default) chooses by the number of dimensions: `"b7"` in 1D and 2D, `"b5"` in
 3D, and narrower kernels beyond. You can choose any of:
 
-| kernel | order of accuracy | highest derivative |
-|---|---|---|
-| `"a0"` | nearest neighbour | none |
-| `"a1"` | linear | none |
-| `"a3"`, `"a4"`, `"a5"`, `"a7"` | cubic and higher | 1 |
-| `"b5"`, `"b7"`, `"b9"`, `"b11"`, `"b13"` | high order | 3 to 7 |
+| kernel | order of accuracy | highest derivative | highest integral |
+|---|---|---|---|
+| `"a0"` | nearest neighbour | none | 2 |
+| `"a1"` | linear | none | 2 |
+| `"a3"`, `"a4"`, `"a5"`, `"a7"` | cubic and higher | 1 | 4 |
+| `"b5"`, `"b7"`, `"b9"`, `"b11"`, `"b13"` | high order | 3 to 7 | 6 to 8 |
 
 ## Boundary conditions
 
@@ -88,6 +99,12 @@ The data are extended beyond each boundary by extrapolation: `bc="detect"` (the
 polynomial extrapolation where the data near the boundary allow it and linear otherwise. You can
 also choose `"poly"`, `"linear"` or `"quadratic"`, separately for each side and each axis.
 
+## Citing
+
+If you use convinterp in your work, please cite it:
+[doi.org/10.5281/zenodo.22972816](https://doi.org/10.5281/zenodo.22972816) (always the latest
+version). A BibTeX entry is on the [About page](https://convinterp.org/about.html).
+
 ## Declaration of AI Assistance
 
 The Rust core and much of the Python code of convinterp were written with substantial assistance
@@ -95,8 +112,8 @@ from Claude (Anthropic). The mathematical methods, the kernels and the reference
 come from the author's Julia package
 [ConvolutionInterpolations.jl](https://github.com/NikoBiele/ConvolutionInterpolations.jl), and the
 port is validated against it: the test suite compares convinterp with the Julia package across
-kernels, boundary conditions, derivative orders and dimensions, with the boundary coefficients
-agreeing bit for bit. The author has reviewed and is responsible for all code.
+kernels, boundary conditions, derivative and integral orders and dimensions, with the boundary
+coefficients agreeing bit for bit. The author has reviewed and is responsible for all code.
 
 ## License
 

{convinterp-0.1.0 → convinterp-0.2.0}/README.md

@@ -1,14 +1,18 @@
 # convinterp
 
 High-order convolution interpolation on uniform grids in any number of dimensions, with
-derivatives, for Python. The core is written in Rust; the kernels are exact polynomials.
+derivatives and integrals, for Python. The core is written in Rust; the kernels are exact
+polynomials.
 
 convinterp is a port of the Julia package
 [ConvolutionInterpolations.jl](https://github.com/NikoBiele/ConvolutionInterpolations.jl), by the
 same author, and is tested against it.
 
-**Status: alpha.** Interpolation and derivatives on uniform grids work in any dimension.
-Integrals and scattered data are coming.
+**Documentation: [convinterp.org](https://convinterp.org)**, with a user guide and accuracy and
+speed comparisons with SciPy.
+
+**Status: alpha.** Interpolation, derivatives and integrals on uniform grids work in any
+dimension. Scattered data are coming.
 
 ## Installation
 
@@ -31,6 +35,10 @@ print(itp(1.0))                                         # ≈ sin(1) = 0.841471
 d_itp = convolution_interpolation(x, np.sin(x), derivative=1)
 print(d_itp(1.0))                                       # ≈ cos(1) = 0.540302
 
+# integrals: a negative order, zero at the first knot x[0] = 0
+i_itp = convolution_interpolation(x, np.sin(x), derivative=-1)
+print(i_itp(1.0))                                       # ≈ 1 − cos(1) = 0.459698
+
 # 2D: one knot array per axis, and data whose axis d runs along knots[d]
 y = np.linspace(0.0, 1.0, 30)                           # knots of the second axis
 data = np.sin(x)[:, None] * np.exp(y)[None, :]          # sin(x)·exp(y) on the 50 × 30 grid
@@ -52,12 +60,12 @@ print(itp2(xs, ys).shape)                               # (3, 4)
 `kernel="auto"` (the default) chooses by the number of dimensions: `"b7"` in 1D and 2D, `"b5"` in
 3D, and narrower kernels beyond. You can choose any of:
 
-| kernel | order of accuracy | highest derivative |
-|---|---|---|
-| `"a0"` | nearest neighbour | none |
-| `"a1"` | linear | none |
-| `"a3"`, `"a4"`, `"a5"`, `"a7"` | cubic and higher | 1 |
-| `"b5"`, `"b7"`, `"b9"`, `"b11"`, `"b13"` | high order | 3 to 7 |
+| kernel | order of accuracy | highest derivative | highest integral |
+|---|---|---|---|
+| `"a0"` | nearest neighbour | none | 2 |
+| `"a1"` | linear | none | 2 |
+| `"a3"`, `"a4"`, `"a5"`, `"a7"` | cubic and higher | 1 | 4 |
+| `"b5"`, `"b7"`, `"b9"`, `"b11"`, `"b13"` | high order | 3 to 7 | 6 to 8 |
 
 ## Boundary conditions
 
@@ -65,6 +73,12 @@ The data are extended beyond each boundary by extrapolation: `bc="detect"` (the
 polynomial extrapolation where the data near the boundary allow it and linear otherwise. You can
 also choose `"poly"`, `"linear"` or `"quadratic"`, separately for each side and each axis.
 
+## Citing
+
+If you use convinterp in your work, please cite it:
+[doi.org/10.5281/zenodo.22972816](https://doi.org/10.5281/zenodo.22972816) (always the latest
+version). A BibTeX entry is on the [About page](https://convinterp.org/about.html).
+
 ## Declaration of AI Assistance
 
 The Rust core and much of the Python code of convinterp were written with substantial assistance
@@ -72,8 +86,8 @@ from Claude (Anthropic). The mathematical methods, the kernels and the reference
 come from the author's Julia package
 [ConvolutionInterpolations.jl](https://github.com/NikoBiele/ConvolutionInterpolations.jl), and the
 port is validated against it: the test suite compares convinterp with the Julia package across
-kernels, boundary conditions, derivative orders and dimensions, with the boundary coefficients
-agreeing bit for bit. The author has reviewed and is responsible for all code.
+kernels, boundary conditions, derivative and integral orders and dimensions, with the boundary
+coefficients agreeing bit for bit. The author has reviewed and is responsible for all code.
 
 ## License
 

convinterp-0.2.0/docs/.gitignore

@@ -0,0 +1 @@
+/.quarto/

convinterp-0.2.0/docs/CNAME

@@ -0,0 +1 @@
+convinterp.org

convinterp-0.2.0/docs/_quarto.yml

@@ -0,0 +1,54 @@
+# Quarto configuration of the convinterp documentation website (https://convinterp.org).
+# Render locally from the repository root with:  quarto render docs
+project:
+  type: website
+  output-dir: _site                  # the built site; never committed, published by CI
+
+website:
+  title: "convinterp"
+  description: "High-order convolution interpolation, derivatives and integrals on uniform grids, with a Rust core"
+  site-url: https://convinterp.org
+  repo-url: https://github.com/NikoBiele/convinterp
+  repo-subdir: docs                  # "edit this page" links point into docs/
+  repo-actions: [edit, issue]        # links under each page's table of contents
+  search: true
+  favicon: assets/logo.svg           # the icon in the browser tab
+  navbar:
+    logo: assets/logo.svg            # the kernel, next to the site title
+    logo-alt: "convinterp logo: the b7 convolution kernel"
+    right:
+      - icon: github
+        href: https://github.com/NikoBiele/convinterp
+        aria-label: GitHub repository
+  sidebar:
+    style: floating                  # always visible on wide screens, as on gert.net
+    contents:
+      - href: index.qmd
+        text: Home
+      - href: guide.qmd
+        text: User guide
+      - href: accuracy.qmd
+        text: Accuracy and performance
+      - href: theory.qmd
+        text: Theory
+      - href: about.qmd
+        text: About
+  page-footer:
+    left: "© 2026 Nikolaj Maack Bielefeld · MIT license"
+    right: "Built with [Quarto](https://quarto.org)"
+
+format:
+  html:
+    theme: cosmo                     # the same theme as gert.net
+    toc: true                        # a table of contents on every page
+    html-math-method: katex          # fast math rendering, as on gert.net
+    code-copy: true                  # a copy button on every code block
+    code-overflow: wrap
+    grid:
+      body-width: 950px              # a wider content column for figures (Quarto's default is 800px)
+      
+jupyter: python3                     # code cells run in Python, against the convinterp built from this repository
+
+execute:
+  echo: true                         # show the code next to its output
+  warning: false                     # keep library warnings out of the pages

convinterp-0.2.0/docs/about.qmd

@@ -0,0 +1,59 @@
+---
+title: "About"
+---
+
+## convinterp and ConvolutionInterpolations.jl
+
+convinterp is a Python port of the Julia package
+[ConvolutionInterpolations.jl](https://github.com/NikoBiele/ConvolutionInterpolations.jl), by the
+same author. Both packages implement the same methods: the b-series kernels, the polynomial
+boundary conditions, and the compensated evaluation of ghost values. convinterp's core is written
+in Rust, and its test suite compares it with the Julia package across kernels, boundary
+conditions, derivative and integral orders and dimensions; the boundary coefficients of the two
+packages agree bit for bit.
+
+Features of the Julia package that convinterp does not provide yet, such as scattered data, are
+listed at the end of the [user guide](guide.qmd#not-available-yet).
+
+## Citing convinterp
+
+If you use convinterp in your work, please cite it. Each release is archived on Zenodo with its
+own DOI; the DOI below always refers to the latest version:
+
+> Bielefeld, N. M. (2026). *convinterp: high-order convolution interpolation, derivatives and
+> integrals on uniform grids*. Zenodo. <https://doi.org/10.5281/zenodo.22972816>
+
+```bibtex
+@software{bielefeld_convinterp,
+  author    = {Bielefeld, Nikolaj Maack},
+  title     = {convinterp: high-order convolution interpolation, derivatives and integrals on uniform grids},
+  year      = {2026},
+  publisher = {Zenodo},
+  doi       = {10.5281/zenodo.22972816},
+  url       = {https://convinterp.org}
+}
+```
+
+To cite one specific version, use its own DOI, listed on the
+[Zenodo record](https://doi.org/10.5281/zenodo.22972816). The GitHub repository also offers
+these details under "Cite this repository".
+
+## Author
+
+Nikolaj Maack Bielefeld ([ORCID 0009-0005-4385-6444](https://orcid.org/0009-0005-4385-6444)).
+Questions, bug reports and suggestions are welcome as
+[issues on GitHub](https://github.com/NikoBiele/convinterp/issues).
+
+## Declaration of AI assistance
+
+The Rust core and much of the Python code of convinterp were written with substantial assistance
+from Claude (Anthropic). The mathematical methods, the kernels and the reference implementation
+come from the author's Julia package ConvolutionInterpolations.jl, and the port is validated
+against it: the test suite compares convinterp with the Julia package across kernels, boundary
+conditions, derivative orders and dimensions, with the boundary coefficients agreeing bit for bit.
+The author has reviewed and is responsible for all code.
+
+## License
+
+convinterp is free software under the
+[MIT license](https://github.com/NikoBiele/convinterp/blob/main/LICENSE).