A modular PyTorch framework for Shallow Recurrent Decoders -- reconstruct full spatiotemporal fields from sparse sensor measurements.
Website: https://yyexela.github.io/SHRED-X/
Full documentation is hosted at yyexela.github.io/SHRED-X and includes:
- Getting Started -- installation and quickstart
- Tutorials -- end-to-end notebooks
- API Reference -- complete module/class/function docs
- Contributing -- development setup and workflow
git clone https://github.com/yyexela/SHRED-X.git
cd SHRED-X
pyenv install 3.13.7
pyenv local 3.13.7
python -m venv ~/.virtualenvs/shredx
source ~/.virtualenvs/shredx/bin/activate
pip install -e .For development (tests, linting, type checking, docs):
pip install -e ".[dev]"If you use SHRED in your research, please cite the relevant papers listed on the Citations page.
See the Contributing guide for details.