Skip to content

Quick Start

An accelerated guide to quickly understand, download, install, use, and apply RAPID to a sample use case.

Overview

Get RAPID running in 3 simple steps.

Quick Installation

git clone https://github.com/c-h-david/rapid2
cd rapid2
pip3 install .

Quick Run

rapid2 -nl namelist.yml

That's it!

Need more details? See the complete Installation Guide and Running Guide.

Sample Use Case

To get started quickly with RAPID, download sample input/output data:

  • San Antonio and Guadalupe River Basins (Texas): Download all input and output data from David et al. (2011, JHM) for a 4-year run (2004-2007) 10.5281/zenodo.16565

  • SIM-France domain: Download all input and output data from David et al. (2011, HP) for a 10-year run (1995-2005) 10.5281/zenodo.30228

Need Help?

For detailed installation and usage instructions, see the Getting Started section.

If you need additional help, please ask on GitHub - feedback is enthusiastically appreciated and new users welcome!