Welcome to OpenHydroNet’s documentation!

This is the documentation for the OpenHydroNet Python package. The source code is available on GitHub.

On this documentation page, you’ll find a quickstart guide with step-by-step instructions on installation, required datasets, and command-line usage. There is also a tutorial that walks you through training your first model. The modelzoo lists the models avaialble in this repository. Finally, the API docs show in-depth information on all modules, classes, and functions within OpenHydroNet.

You might also be interested in our team’s webpage.

Contents:

• Quick Start
  • Obtain the Code
  • Prerequisites & Environment Setup
  • Installation
  • Data Setup
  • Training Configuration
  • Usage
• Modelzoo
  • Model Heads
  • Model Classes
• Tutorial: Evaluation and Fine-Tuning
  • Interactive Version
  • Core Concepts
  • Prerequisites
  • Data Requirements
  • Notebook File
• Configuration Arguments
  • General experiment configurations
  • Validation settings
  • Evaluation settings
  • General model configuration
  • Embedding network settings
  • Training settings
  • Data settings
  • Finetune settings
  • Logger settings
• googlehydrology
  • googlehydrology package
• Example Configuration Files
  • Overview
  • Configuration Files
  • Operational Models
  • Benchmarking & Development