This is the official GitHub home for the tRIBS (TIN-based Real-time Integrated Basin Simulator) model and its associated tools. tRIBS is a physically-based, distributed hydrologic model used with a wide range of applications.
Note
tRIBS v6.0.0 and pytRIBS v1.0.0 are out. This is a coordinated release: the model, the Python tools, the benchmarks/examples, and the documentation have all been updated together. See the tRIBS v6.0.0 release notes and the pytRIBS v1.0.0 release notes. Existing users should read the release notes before upgrading.
tRIBS is a C++ model that simulates the hydrologic processes of a watershed. Our goal is to provide a robust, open-source platform for hydrologic modeling and to foster a community of users and developers.
Here are the main repositories managed by this organization:
- tRIBS-Model/tRIBS: The core C++ source code for the hydrologic model. This is where you'll find the latest developments.
- tRIBS-Model/pytRIBS: A pre-to-post processing python package for tRIBS, making model setup and analysis much easier.
- tRIBS-Model/pytRIBS-examples: An example walkthrough for setting up and run a model using pytRIBS.
- tRIBS-Model/tRIBS-benchmarks: A set of official benchmark cases for the tRIBS to validate a new tRIBS installation and explore example datasets.
- tRIBS-Model/tRIBS-Workshop-Sandbox: An example walkthrough for setting up and running a tRIBS model inside of a web browser.
- tRIBS-Model/rtdocs: The source code for our official documentation and user wiki, hosted on Read the Docs.
The best place to start is with our official documentation.
Read the tRIBS Documentation on Read the Docs
We welcome contributions from the community! Whether it's reporting a bug, suggesting a feature, or submitting code, your help is appreciated.
All pull requests are reviewed by our Core-Maintainers before being merged.
If you use this version of tRIBS (5.2 or above) in your research, please cite our JOSS paper:
Raming, L.W., Vivoni, E.R., Mascaro, G., Cederstrom, C.J., Ko, A., Schreiner-McGraw, A.P., and Lizarraga-Celaya, C. (2024). tRIBS v5.2: A multi-resolution, parallel platform for tributary hydrology in forest applications. Journal of Open Source Software, 9(101), 6747, https://doi.org/10.21105/joss.06747