Bakaano-Hydro Documentation

Bakaano-Hydro is a distributed hydrology-guided neural network model for streamflow prediction. The documentation below is organized by user task first, then by module reference.

Conceptual overview of the Bakaano-Hydro pipeline.

Start Here

Common tasks

I want to…	Go here
Set up a project and check required files	Project Setup
Run one end-to-end minimal example	Quick Start
Train a model	Training
Validate a trained model	Evaluation
Simulate stations or lat/lon points	Simulation
Understand package layout and data flow	Overview
Use scenario or flood extensions	Extensions
Migrate from older package paths	Migration

Start with Colab

Recommended entry point for new users:

• Open Beginner Colab

• Open Advanced Colab

• Notebook sources on GitHub

Advanced workflow notebooks:

• Scenario workflow notebook

• Flood-mapping workflow notebook

Getting Started

• Installation
  • Requirements
  • Create a new environment
  • Install (GPU)
  • Install (CPU)
  • Preview docs locally
  • Data requirements
• Overview
  • Pipeline diagram
  • Package diagram
  • Artifact flow
  • Which function should I use?
• Project Setup
  • Minimal setup
  • Project helper methods
  • Preflight checks
  • Common failure modes
• Quick Start
  • Colab notebooks
  • Minimal working example
  • Before you run expensive steps
  • Important notes
  • Where to go next
• Training
  • Minimal working example
  • Train with station CSVs
  • Required inputs
  • Training outputs
  • Parameter guide
  • Optional routed rainfall
  • Common failure modes
• Evaluation
  • Minimal working example
  • Evaluate with station CSVs
  • How it works
  • Common failure modes
• Simulation
  • Simulate station sets
  • Simulate station CSV sets
  • Simulate arbitrary lat/lon points
  • Outputs
  • Important timing rule
  • Common failure modes
• Extensions
  • Scenario extension
  • Flood-mapping extension
  • When to use extensions
  • Notebook entry points
• Inputs and Outputs
  • Global assumptions
  • Observed streamflow CSV schema
  • Predicted streamflow units
  • Module reference
• Model Configuration
  • User-defined inputs
  • Recommended settings
• Troubleshooting
  • Google Earth Engine authentication
  • No stations found inside the basin
  • Missing columns in CSVs
  • Predictions are all zeros or flatlines
  • Missing or empty raster inputs
  • Observed streamflow dates out of range
  • Mismatched routing method
  • Unsupported climate data source
  • VegET rerun starts from day 1 after interruption
  • Model expects routed rainfall but simulation only has runoff
  • AlphaEarth scaling or missing scaler
  • Model outputs in unexpected units
• Migration
  • Canonical package names
  • Canonical entry points
  • Legacy notes

Reference

• API Structure
  • Canonical package layout
  • High-level entry points
  • Data preparation modules
  • Hydrology modules
  • Plotting helpers
  • Advanced workflows
• API Reference
  • Core modules

Indices and tables

• Index

• Module Index

• Search Page