xesn
xesn: Echo state networks powered by Xarray and Dask - Published in JOSS (2024)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 13 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: arxiv.org, joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Mathematics
Computer Science -
84% confidence
Last synced: 6 months ago
·
JSON representation
Repository
Large scale Echo State Networks powered by xarray and dask.
Basic Info
- Host: GitHub
- Owner: timothyas
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://xesn.readthedocs.io
- Size: 1.94 MB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
- Releases: 9
Created about 3 years ago
· Last pushed over 1 year ago
Metadata Files
Readme
Contributing
License
Support
Codemeta
README.md
xesn
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
shell
conda install -c conda-forge xesn
Installation from pip
shell
pip install xesn
Installation from source
shell
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::
shell
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:
tex
@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}
}
Owner
- Name: Timothy Smith
- Login: timothyas
- Kind: user
- Location: Boulder, CO
- Company: NOAA PSL / CIRES
- Website: timothyas.github.io
- Repositories: 31
- Profile: https://github.com/timothyas
JOSS Publication
xesn: Echo state networks powered by Xarray and Dask
Published
November 12, 2024
Volume 9, Issue 103, Page 7286
Authors
Timothy A. Smith
Physical Sciences Laboratory (PSL), National Oceanic and Atmospheric Administration (NOAA), Boulder, CO, USA
Physical Sciences Laboratory (PSL), National Oceanic and Atmospheric Administration (NOAA), Boulder, CO, USA
Stephen G. Penny
Sofar Ocean, San Francisco, CA, USA, Cooperative Institute for Research in Environmental Sciences (CIRES) at the University of Colorado Boulder, Boulder, CO, USA
Sofar Ocean, San Francisco, CA, USA, Cooperative Institute for Research in Environmental Sciences (CIRES) at the University of Colorado Boulder, Boulder, CO, USA
Jason A. Platt
University of California San Diego (UCSD), La Jolla, CA, USA
University of California San Diego (UCSD), La Jolla, CA, USA
Tse-Chun Chen
Pacific Northwest National Laboratory, Richland, WA, USA
Pacific Northwest National Laboratory, Richland, WA, USA
Editor
Jonny Saunders
Tags
echo state networks xarray dask numpy cupyCodeMeta (codemeta.json)
{
"@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
"@type": "Code",
"author": [],
"identifier": "",
"codeRepository": "https://github.com/timothyas/xesn",
"datePublished": "2024-11-01",
"dateModified": "2024-11-01",
"dateCreated": "2023-12-15",
"description": "Echo State Networks powered by xarray and dask.",
"keywords": "echo state networks, machine learning, weather, climate, forecasting",
"license": "Apache-2.0",
"title": "xesn",
"version": "v0.2.0"
}GitHub Events
Total
- Create event: 7
- Release event: 3
- Issues event: 4
- Watch event: 1
- Delete event: 5
- Issue comment event: 18
- Push event: 25
- Pull request review event: 1
- Pull request event: 8
Last Year
- Create event: 7
- Release event: 3
- Issues event: 4
- Watch event: 1
- Delete event: 5
- Issue comment event: 18
- Push event: 25
- Pull request review event: 1
- Pull request event: 8
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Timothy Smith | s****w@g****m | 69 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 36
- Total pull requests: 47
- Average time to close issues: 27 days
- Average time to close pull requests: 3 days
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 1.28
- Average comments per pull request: 0.64
- Merged pull requests: 47
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 5
- Average time to close issues: 2 days
- Average time to close pull requests: about 10 hours
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 4.0
- Average comments per pull request: 1.6
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- timothyas (31)
- sneakers-the-rat (2)
Pull Request Authors
- timothyas (57)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 25 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 8
- Total maintainers: 1
pypi.org: xesn
Echo State Networks powered by xarray
- Documentation: https://xesn.readthedocs.io/
- License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
Latest release: 0.2.2
published over 1 year ago
Rankings
Dependent packages count: 10.0%
Average: 38.8%
Dependent repos count: 67.5%
Maintainers (1)
Last synced:
6 months ago
Dependencies
.github/workflows/ci.yaml
actions
- actions/cache v2 composite
- actions/checkout v2 composite
- codecov/codecov-action v3 composite
- conda-incubator/setup-miniconda v2 composite
pyproject.toml
pypi
- dask [complete]
- matplotlib *
- numpy *
- scipy *
- smt >=2.0.1
- xarray *
- zarr *
.github/workflows/sphinx.yaml
actions
- actions/cache v2 composite
- actions/checkout v2 composite
- conda-incubator/setup-miniconda v2 composite
.github/workflows/publish.yaml
actions
- actions/checkout v3 composite
- actions/setup-python v3 composite
- pypa/gh-action-pypi-publish release/v1 composite
ci/environment.yaml
conda
- bottleneck
- coverage
- dask
- jupyter
- matplotlib
- netcdf4
- numpy
- pytest
- scipy
- smt >=2.2.1
- xarray
- zarr
docs/environment.yaml
conda
- bottleneck
- coverage
- dask
- jupyter
- matplotlib
- nbsphinx
- netcdf4
- numpy
- pytest
- python 3.11.*
- scipy
- seaborn
- smt >=2.2.1
- sphinx-book-theme
- sphinxcontrib-bibtex
- xarray
- zarr