PySHRED documentation#

Useful links: Installation | Source repository | Issue tracker

PySHRED is an open-source software implementing the SHallow REcurrent Decoder (SHRED) architecture for sensing applications. PySHRED achieves state-of-the-art accuracy on full-state reconstructions and forecasting of spatiotemporal dynamics from very few sensors.

Getting started

New to PySHRED? Check out the Get Shredding Guide.

User guide

The user guide provides in-depth information on the key concepts of PySHRED with useful background information and explanation.

API reference

The reference guide contains a detailed description of the functions, modules, and objects included in PySHRED. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.

Example Gallery

Explore real-world applications of PySHRED in Google Colab or Jupyter Notebook.