ntsa 0.1.0__tar.gz

ntsa-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andrea Nóvoa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ntsa-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include tests *.py

ntsa-0.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: ntsa
+Version: 0.1.0
+Summary: Nonlinear time-series analysis for dynamical-system models: Lyapunov spectra, delay embeddings, regime classification, bifurcation sweeps
+Author-email: Andrea Nóvoa <a.novoa@imperial.ac.uk>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/andreanovoa/ntsa
+Project-URL: Repository, https://github.com/andreanovoa/ntsa
+Project-URL: Issues, https://github.com/andreanovoa/ntsa/issues
+Keywords: nonlinear-time-series,lyapunov-exponents,chaos,delay-embedding,bifurcation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dynamodels<1.0,>=0.1
+Requires-Dist: matplotlib<4.0,>=3.9
+Requires-Dist: numpy<3.0,>=2.0
+Requires-Dist: scipy<2.0,>=1.13
+Requires-Dist: tqdm>=4.67
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# ntsa — nonlinear time-series analysis for dynamical-system models
+
+Characterizes the dynamical regime of a model from a single long trajectory:
+delay embedding (optimal lag + false nearest neighbours), Lyapunov exponents, regime
+classification (fixed point / limit cycle period-k / frequency-locked / quasiperiodic / chaotic),
+and a per-case diagnostic figure — one row of 8 panels
+[time series | PSD | 3-D delay portrait | first-return map of local maxima | plane-crossing Poincaré section
+| recurrence plot | 3-D MDS | Lyapunov spectrum] — Key Reference: Kantz & Schreiber,
+*Nonlinear Time Series Analysis* (2004).
+
+**Documentation: [andreanovoa.github.io/ntsa](https://andreanovoa.github.io/ntsa/)**
+| Tutorial: [`tutorial_ntsa.ipynb`](tutorial_ntsa.ipynb)
+
+### Example:
+
+<img width="2877" height="1659" alt="image" src="https://github.com/user-attachments/assets/d366a1f1-6980-4bee-ae1c-a00c514c33b4" />
+
+## Install
+
+```bash
+pip install ntsa            # once released; until then (dynamodels is not on PyPI yet either):
+pip install "dynamodels @ git+https://github.com/andreanovoa/dynamodels" \
+            "ntsa @ git+https://github.com/andreanovoa/ntsa"
+```
+
+## Quickstart
+
+```python
+from dynamodels.physical import Lorenz63
+from ntsa import characterize as chz
+
+chz.characterize([Lorenz63()], pdf_name='figs/l63.pdf')
+```
+
+```bash
+python -m ntsa.characterize          # 4-case demo -> figs/ntsa_defaults.pdf (+ .png)
+```
+
+Works with any model implementing the
+[model protocol](https://andreanovoa.github.io/ntsa/protocol/) —
+[`dynamodels`](https://github.com/andreanovoa/dynamodels) is the reference
+implementation. Part of the same ecosystem as
+[romda](https://github.com/andreanovoa/real-time-bias-aware-DA) (real-time
+bias-aware data assimilation).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python -m pytest tests/
+ruff check ntsa/ tests/
+```
+
+Releases publish to PyPI via trusted publishing on version tags; docs deploy to
+GitHub Pages on push to `main` (see `.github/workflows/`).
+
+## License
+
+MIT

ntsa-0.1.0/README.md

@@ -0,0 +1,59 @@
+# ntsa — nonlinear time-series analysis for dynamical-system models
+
+Characterizes the dynamical regime of a model from a single long trajectory:
+delay embedding (optimal lag + false nearest neighbours), Lyapunov exponents, regime
+classification (fixed point / limit cycle period-k / frequency-locked / quasiperiodic / chaotic),
+and a per-case diagnostic figure — one row of 8 panels
+[time series | PSD | 3-D delay portrait | first-return map of local maxima | plane-crossing Poincaré section
+| recurrence plot | 3-D MDS | Lyapunov spectrum] — Key Reference: Kantz & Schreiber,
+*Nonlinear Time Series Analysis* (2004).
+
+**Documentation: [andreanovoa.github.io/ntsa](https://andreanovoa.github.io/ntsa/)**
+| Tutorial: [`tutorial_ntsa.ipynb`](tutorial_ntsa.ipynb)
+
+### Example:
+
+<img width="2877" height="1659" alt="image" src="https://github.com/user-attachments/assets/d366a1f1-6980-4bee-ae1c-a00c514c33b4" />
+
+## Install
+
+```bash
+pip install ntsa            # once released; until then (dynamodels is not on PyPI yet either):
+pip install "dynamodels @ git+https://github.com/andreanovoa/dynamodels" \
+            "ntsa @ git+https://github.com/andreanovoa/ntsa"
+```
+
+## Quickstart
+
+```python
+from dynamodels.physical import Lorenz63
+from ntsa import characterize as chz
+
+chz.characterize([Lorenz63()], pdf_name='figs/l63.pdf')
+```
+
+```bash
+python -m ntsa.characterize          # 4-case demo -> figs/ntsa_defaults.pdf (+ .png)
+```
+
+Works with any model implementing the
+[model protocol](https://andreanovoa.github.io/ntsa/protocol/) —
+[`dynamodels`](https://github.com/andreanovoa/dynamodels) is the reference
+implementation. Part of the same ecosystem as
+[romda](https://github.com/andreanovoa/real-time-bias-aware-DA) (real-time
+bias-aware data assimilation).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python -m pytest tests/
+ruff check ntsa/ tests/
+```
+
+Releases publish to PyPI via trusted publishing on version tags; docs deploy to
+GitHub Pages on push to `main` (see `.github/workflows/`).
+
+## License
+
+MIT

ntsa-0.1.0/ntsa/__init__.py

@@ -0,0 +1,16 @@
+"""ntsa — nonlinear time-series analysis for dynamical-system models.
+
+- `ntsa.tools` — delay embeddings, return/Poincaré maps, recurrence, MDS,
+  regime classification, bifurcation sweeps.
+- `ntsa.lyapunov` — Benettin QR spectrum, leading exponent, Kaplan-Yorke.
+- `ntsa.characterize` — per-case diagnostic figure rows and a demo driver
+  (``python -m ntsa.characterize``).
+
+Works with any model implementing the `dynamodels.Model` interface (see the
+"Model protocol" section of the README) — `dynamodels` is the reference
+implementation used by the demos and tests, but any duck-type is accepted.
+
+Reference: Kantz & Schreiber, *Nonlinear Time Series Analysis* (2nd ed., CUP 2004).
+"""
+
+__version__ = "0.1.0"