BASED: Boost-Assisted Stream Estimator for Depth

BASED is an XGBoost regressor deployed using Streamlit, designed for predicting channel depth using channel width, slope, and discharge.

Features

• 🌊 Accurate channel depth predictions
• 🚀 Fast inference using XGBoost
• 🖥️ User-friendly Streamlit interface
• 📊 Built-in error benchmarks and validation

Quick Start

1. Clone the repository:

   git clone https://github.com/JakeGearon/based-api.git
   cd based-api
   

2. Install dependencies:

   poetry install
   

3. Run the Streamlit app:

   poetry run streamlit run st_app.py
   

4. Input values for slope, discharge, and width to predict channel depth.

Model Performance

• Mean Absolute Error (MAE): 0.24 cm
• Root Mean Square Error (RMSE): 0.55
• R-squared (R²): 0.97

Image source: Gearon, J.H. et al. Rules of river avulsion change downstream. Nature 634, 91–95 (2024). https://doi.org/10.1038/s41586-024-07964-2

Citation

If you use BASED in your research, please either cite the paper it came from (above) or the software itself as follows:

Gearon, J. (2024). Boost-Assisted Stream Estimator for Depth (BASED) [Computer software]. Version 1.0.0. https://github.com/JakeGearon/based-api

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Contact

Jake Gearon - [email protected]

Project Link: https://based-estimator.streamlit.app/