echostatenetwork 0.1.1__tar.gz

echostatenetwork-0.1.1/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.

echostatenetwork-0.1.1/MANIFEST.in

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

echostatenetwork-0.1.1/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: echostatenetwork
+Version: 0.1.1
+Summary: Echo state networks / reservoir computing in pure numpy: ridge training, recycle validation, ragged segments, parametric inputs, Bayesian hyperparameter search
+Author-email: Andrea Nóvoa <a.novoa@imperial.ac.uk>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/andreanovoa/EchoStateNetwork
+Project-URL: Repository, https://github.com/andreanovoa/EchoStateNetwork
+Project-URL: Issues, https://github.com/andreanovoa/EchoStateNetwork/issues
+Keywords: echo-state-network,reservoir-computing,time-series,recurrent-network
+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: matplotlib<4.0,>=3.9
+Requires-Dist: numpy<3.0,>=2.0
+Requires-Dist: scipy<2.0,>=1.13
+Provides-Extra: opt
+Requires-Dist: scikit-optimize>=0.9; extra == "opt"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: scikit-optimize>=0.9; extra == "dev"
+Dynamic: license-file
+
+# EchoStateNetwork
+
+Echo state networks / reservoir computing in pure numpy. One class,
+`EchoStateNetwork`: ridge-regression training with chaotic recycle validation
+(contiguous runs or ragged dwell segments), parametric inputs, optional Bayesian
+hyperparameter search (`scikit-optimize`), closed-loop prediction, and Jacobians
+for data assimilation.
+
+This is the single shared reservoir core behind
+[`qlrom`](https://github.com/andreanovoa/qlrom) (quantized-local ESN families) and
+[`romda`](https://github.com/andreanovoa/romda) (real-time ESN forecasting and
+bias-aware data assimilation).
+
+## Install
+
+```bash
+pip install echostatenetwork          # core (numpy/scipy/matplotlib)
+pip install "echostatenetwork[opt]"   # + scikit-optimize for Bayesian hyperparameter search
+pip install -e ".[dev]"               # development
+```
+
+## Quickstart
+
+```python
+import numpy as np
+from echostatenetwork import EchoStateNetwork
+
+y = my_time_series                       # (Nt, N_dim)
+esn = EchoStateNetwork(y, dt=0.01, N_units=200, t_train=40.0, t_val=4.0)
+esn.train([y])
+u_wash, r = ...                          # see docstrings: washout then closed loop
+```
+
+## Acknowledgements
+
+This repository is based on
+[alberacca/Echo-State-Networks](https://github.com/alberacca/Echo-State-Networks),
+the reference implementation of the recycle-validation ESN:
+
+> Racca, A., & Magri, L. (2021). Robust optimization and validation of echo state
+> networks for learning chaotic dynamics. *Neural Networks*, 142, 252-268.
+> [doi:10.1016/j.neunet.2021.05.004](https://doi.org/10.1016/j.neunet.2021.05.004)

echostatenetwork-0.1.1/README.md

@@ -0,0 +1,42 @@
+# EchoStateNetwork
+
+Echo state networks / reservoir computing in pure numpy. One class,
+`EchoStateNetwork`: ridge-regression training with chaotic recycle validation
+(contiguous runs or ragged dwell segments), parametric inputs, optional Bayesian
+hyperparameter search (`scikit-optimize`), closed-loop prediction, and Jacobians
+for data assimilation.
+
+This is the single shared reservoir core behind
+[`qlrom`](https://github.com/andreanovoa/qlrom) (quantized-local ESN families) and
+[`romda`](https://github.com/andreanovoa/romda) (real-time ESN forecasting and
+bias-aware data assimilation).
+
+## Install
+
+```bash
+pip install echostatenetwork          # core (numpy/scipy/matplotlib)
+pip install "echostatenetwork[opt]"   # + scikit-optimize for Bayesian hyperparameter search
+pip install -e ".[dev]"               # development
+```
+
+## Quickstart
+
+```python
+import numpy as np
+from echostatenetwork import EchoStateNetwork
+
+y = my_time_series                       # (Nt, N_dim)
+esn = EchoStateNetwork(y, dt=0.01, N_units=200, t_train=40.0, t_val=4.0)
+esn.train([y])
+u_wash, r = ...                          # see docstrings: washout then closed loop
+```
+
+## Acknowledgements
+
+This repository is based on
+[alberacca/Echo-State-Networks](https://github.com/alberacca/Echo-State-Networks),
+the reference implementation of the recycle-validation ESN:
+
+> Racca, A., & Magri, L. (2021). Robust optimization and validation of echo state
+> networks for learning chaotic dynamics. *Neural Networks*, 142, 252-268.
+> [doi:10.1016/j.neunet.2021.05.004](https://doi.org/10.1016/j.neunet.2021.05.004)

echostatenetwork-0.1.1/echostatenetwork/__init__.py

@@ -0,0 +1,13 @@
+"""Echo state networks / reservoir computing, pure numpy.
+
+One class, EchoStateNetwork: training (ridge regression with recycle validation,
+contiguous or ragged dwell segments), Bayesian hyperparameter search (optional
+scikit-optimize), parametric inputs, closed-loop prediction and Jacobians.
+Shared by the qlrom (qlESN families) and romda (ESN_model, ESN_bias) packages.
+"""
+
+from .esn import EchoStateNetwork
+
+__version__ = "0.1.1"
+
+__all__ = ["EchoStateNetwork"]