.. OpenHydroNet documentation master file, created by
   sphinx-quickstart on Mon Aug 17 14:00:15 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OpenHydroNet's documentation!
===========================================

This is the documentation for the OpenHydroNet Python package.
The source code is available on `GitHub <https://github.com/google-research/flood-forecasting/>`_.

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

You might also be interested in our `team's webpage <https://sites.research.google/gr/floodforecasting/>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   usage/quickstart
   usage/models
   tutorial/tutorial
   usage/config
   api/modules
   example-configs/example-configs