interpn 0.1.5__tar.gz → 0.2.0__tar.gz

{interpn-0.1.5 → interpn-0.2.0}/.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
     branches: [ "*" ]
   workflow_dispatch:
   workflow_call:
-# on: [workflow_call]  # allow this workflow to be called from other workflows
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -35,4 +35,6 @@ jobs:
     - name: Static typing - python
       run: source ../env/bin/activate; pyright ./interpn
     - name: Test - python
-      run: source ../env/bin/activate; pytest .
+      run: |
+        source ../env/bin/activate; pytest .
+        python ./examples/cubic_comparison.py test

{interpn-0.1.5 → interpn-0.2.0}/Cargo.lock

@@ -29,12 +29,6 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
-[[package]]
-name = "either"
-version = "1.9.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
-
 [[package]]
 name = "heck"
 version = "0.4.1"
@@ -49,23 +43,13 @@ checksum = "1e186cfbae8084e513daff4240b4797e342f988cecda4fb6c939150f96315fd8"
 
 [[package]]
 name = "interpn"
-version = "0.3.0"
+version = "0.4.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "835b8d2193df554005b76228d2b80544cc6a7daaefbcc0ce2ba5a2ec56dcf7fb"
+checksum = "82ec859d62d17054a7314d5bb47d7e4eeb4648b87b7c1e0e33de1d4df21e0375"
 dependencies = [
- "itertools",
  "num-traits",
 ]
 
-[[package]]
-name = "itertools"
-version = "0.12.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "25db6b064527c5d482d0423354fcd07a89a2dfe07b67892e62411946db7f07b0"
-dependencies = [
- "either",
-]
-
 [[package]]
 name = "libc"
 version = "0.2.150"

{interpn-0.1.5 → interpn-0.2.0}/Cargo.toml

@@ -11,14 +11,15 @@ crate-type = ["cdylib"]
 [dependencies]
 pyo3 = "0.20.0"
 numpy = "0.20.0"
-interpn = "0.3.0"
-# interpn = { path = "../interpn/interpn" }
+interpn = {version = "0.4.1", default_features = false}
+#interpn = { path = "../interpn/interpn" }
 
 [profile.release]
 opt-level = 3
 codegen-units = 1
 lto = true
 strip = true
+overflow-checks = true
 
 [profile.dev]
 opt-level = 3

interpn-0.2.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.3
+Name: interpn
+Version: 0.2.0
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: numpy >=1
+Requires-Dist: pydantic >=2.5.2
+Requires-Dist: pytest >=7.4.3 ; extra == 'test'
+Requires-Dist: coverage >=7.3.2 ; extra == 'test'
+Requires-Dist: ruff >=0.1.6 ; extra == 'test'
+Requires-Dist: pyright >=1.1.337 ; extra == 'test'
+Requires-Dist: mktestdocs >=0.2.1 ; extra == 'test'
+Requires-Dist: scipy >=1.11.4 ; extra == 'test'
+Requires-Dist: matplotlib >=3.8 ; extra == 'test'
+Requires-Dist: scipy >=1.11.4 ; extra == 'bench'
+Requires-Dist: matplotlib >=3.8 ; extra == 'bench'
+Requires-Dist: memory-profiler >=0.61.0 ; extra == 'bench'
+Requires-Dist: mkdocs >=1.5.3 ; extra == 'doc'
+Requires-Dist: mkdocstrings-python >=1.7.5 ; extra == 'doc'
+Requires-Dist: mkdocs-material >=9.4.10 ; extra == 'doc'
+Provides-Extra: test
+Provides-Extra: bench
+Provides-Extra: doc
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Summary: N-dimensional interpolation/extrapolation methods
+Author-email: jlogan03@gmail.com
+Requires-Python: >=3.9, <3.12
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# interpn
+
+Python bindings to the `interpn` Rust library for N-dimensional interpolation and extrapolation. 
+
+[Docs](https://interpnpy.readthedocs.io/en/latest/) |
+[Repo](https://github.com/jlogan03/interpnpy) |
+[Rust Library (github)](https://github.com/jlogan03/interpn) | 
+[Rust Docs (docs.rs)](https://docs.rs/interpn/latest/interpn/)
+
+## Features
+| Feature →<br>↓ Interpolant Method | Regular<br>Grid | Rectilinear<br>Grid | Json<br>Serialization |
+|-----------------------------------|-----------------|---------------------|-----------------------|
+| Linear                            |   ✅            |     ✅              | ✅                    |
+| Cubic                             |   ✅            |     💡              | ✅                    |
+
+The methods provided here, while more limited in scope than scipy's, are
+* significantly faster for higher dimensions (1-3 orders of magnitude under most conditions)
+* use almost no RAM (and perform no heap allocations at all)
+* produce significantly improved floating-point error (by 1-2 orders of magnitude)
+* are json-serializable using Pydantic
+* can also be used easily in web and embedded applications via the Rust library
+
+See [here](https://interpnpy.readthedocs.io/en/latest/perf/) for more info about quality-of-fit, throughput, and memory usage.
+
+
+## Example: Multilinear Interpolation on a Regular Grid
+```python
+import interpn
+import numpy as np
+
+# Build grid
+x = np.linspace(0.0, 10.0, 5)
+y = np.linspace(20.0, 30.0, 3)
+
+xgrid, ygrid = np.meshgrid(x, y, indexing="ij")
+zgrid = (xgrid + 2.0 * ygrid)  # Values at grid points
+
+# Grid inputs for true regular grid
+dims = [x.size, y.size]
+starts = np.array([x[0], y[0]])
+steps = np.array([x[1] - x[0], y[1] - y[0]])
+
+# Observation points pointed back at the grid
+obs = [xgrid.flatten(), ygrid.flatten()]
+
+# Initialize
+interpolator = interpn.MultilinearRegular.new(
+    dims, starts, steps, zgrid.flatten()
+)
+
+# Interpolate
+out = interpolator.eval(obs)
+
+# Check result
+assert np.all(out == zgrid.flatten())
+
+# Serialize and deserialize
+roundtrip_interpolator = interpn.MultilinearRegular.model_validate_json(
+    interpolator.model_dump_json()
+)
+out2 = roundtrip_interpolator.eval(obs)
+
+# Check result from roundtrip serialized/deserialized interpolator
+assert np.all(out == out2)
+```
+
+
+# License
+Licensed under either of
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.

interpn-0.2.0/README.md

@@ -0,0 +1,74 @@
+# interpn
+
+Python bindings to the `interpn` Rust library for N-dimensional interpolation and extrapolation. 
+
+[Docs](https://interpnpy.readthedocs.io/en/latest/) |
+[Repo](https://github.com/jlogan03/interpnpy) |
+[Rust Library (github)](https://github.com/jlogan03/interpn) | 
+[Rust Docs (docs.rs)](https://docs.rs/interpn/latest/interpn/)
+
+## Features
+| Feature →<br>↓ Interpolant Method | Regular<br>Grid | Rectilinear<br>Grid | Json<br>Serialization |
+|-----------------------------------|-----------------|---------------------|-----------------------|
+| Linear                            |   ✅            |     ✅              | ✅                    |
+| Cubic                             |   ✅            |     💡              | ✅                    |
+
+The methods provided here, while more limited in scope than scipy's, are
+* significantly faster for higher dimensions (1-3 orders of magnitude under most conditions)
+* use almost no RAM (and perform no heap allocations at all)
+* produce significantly improved floating-point error (by 1-2 orders of magnitude)
+* are json-serializable using Pydantic
+* can also be used easily in web and embedded applications via the Rust library
+
+See [here](https://interpnpy.readthedocs.io/en/latest/perf/) for more info about quality-of-fit, throughput, and memory usage.
+
+
+## Example: Multilinear Interpolation on a Regular Grid
+```python
+import interpn
+import numpy as np
+
+# Build grid
+x = np.linspace(0.0, 10.0, 5)
+y = np.linspace(20.0, 30.0, 3)
+
+xgrid, ygrid = np.meshgrid(x, y, indexing="ij")
+zgrid = (xgrid + 2.0 * ygrid)  # Values at grid points
+
+# Grid inputs for true regular grid
+dims = [x.size, y.size]
+starts = np.array([x[0], y[0]])
+steps = np.array([x[1] - x[0], y[1] - y[0]])
+
+# Observation points pointed back at the grid
+obs = [xgrid.flatten(), ygrid.flatten()]
+
+# Initialize
+interpolator = interpn.MultilinearRegular.new(
+    dims, starts, steps, zgrid.flatten()
+)
+
+# Interpolate
+out = interpolator.eval(obs)
+
+# Check result
+assert np.all(out == zgrid.flatten())
+
+# Serialize and deserialize
+roundtrip_interpolator = interpn.MultilinearRegular.model_validate_json(
+    interpolator.model_dump_json()
+)
+out2 = roundtrip_interpolator.eval(obs)
+
+# Check result from roundtrip serialized/deserialized interpolator
+assert np.all(out == out2)
+```
+
+
+# License
+Licensed under either of
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.