Skip to main content

Echo State Networks powered by xarray

Project description

xesn

codecov Documentation Status Conda Version PyPI version

DOI

Echo State Networks powered by xarray and dask.

Description

xesn is a python package for implementing Echo State Networks (ESNs), a particular form of Recurrent Neural Network originally introduced by Jaeger (2001). The main purpose of the package is to enable ESNs for relatively large scale weather and climate applications, for example as by Smith et al., (2023) and Arcomano et al., (2020). The package is designed to strike the balance between simplicity and flexibility, with a focus on implementing features that were shown to matter most by Platt et al., (2022).

xesn uses xarray to handle multi-dimensional data, relying on dask for parallelization and to handle datasets/networks that are too large for a single compute node. At its core, xesn uses numpy and cupy for efficient CPU and GPU deployment.

Installation

Installation from conda-forge

conda install -c conda-forge xesn

Installation from pip

pip install xesn

Installation from source

git clone https://github.com/timothyas/xesn.git
cd xesn
pip install -e .

Note that additional dependencies can be installed to run the unit test suite::

pip install -e .[test]
pytest xesn/test/*.py

Getting Started

To learn how to use xesn, check out the documentation here

Get in touch

Report bugs, suggest features, or view the source code on GitHub.

License and Copyright

xesn is licensed under the Apache-2.0 License.

Development occurs on GitHub at https://github.com/timothyas/xesn.

Citation

If you find xesn useful, we would appreciate it if you cite the package as follows:

Smith et al., (2024). xesn: Echo state networks powered by Xarray and Dask. Journal of Open Source Software, 9(103), 7286, https://doi.org/10.21105/joss.07286

Here's a sample bibtex entry:

@article{
    Smith2024,
    doi = {10.21105/joss.07286},
    url = {https://doi.org/10.21105/joss.07286},
    year = {2024}, publisher = {The Open Journal},
    volume = {9},
    number = {103},
    pages = {7286},
    author = {Timothy A. Smith and Stephen G. Penny and Jason A. Platt and Tse-Chun Chen},
    title = {xesn: Echo state networks powered by Xarray and Dask},
    journal = {Journal of Open Source Software}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xesn-0.2.2.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

xesn-0.2.2-py3-none-any.whl (57.7 kB view details)

Uploaded Python 3

File details

Details for the file xesn-0.2.2.tar.gz.

File metadata

  • Download URL: xesn-0.2.2.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xesn-0.2.2.tar.gz
Algorithm Hash digest
SHA256 569240f3c0f2e04d0981f333c319d9f2f86d26a6f87f12273a12a2332be11b7a
MD5 0905a2240fab1b7cf636d972f1809cc5
BLAKE2b-256 3ab143e8f820b1cda8b7530a9779c420c4c883210c58e607089c7d3666bdf0c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for xesn-0.2.2.tar.gz:

Publisher: publish.yaml on timothyas/xesn

Attestations:

File details

Details for the file xesn-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: xesn-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 57.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xesn-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 84fdbb97de32229d78e3361a75d9540645cb1126f621639a1989826ad1be2be0
MD5 0d773b28082e8b67e3453f0b1abf6290
BLAKE2b-256 887b8cb19a5eee3528a5df51067d7035800b4fb046d57f97564c9efc427c7d3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for xesn-0.2.2-py3-none-any.whl:

Publisher: publish.yaml on timothyas/xesn

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page