.. torchHydroNodes documentation master file, created by
   sphinx-quickstart.
   You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.


Welcome to torchHydroNodes' Documentation!
===========================================

This is the documentation for the **torchHydroNodes** Python package.
The source code is available on `GitHub <https://github.com/jpcurbelo/torchHydroNodes/>`_. In this documentation, you'll find:

- A `getting started guide <usage/getting_started.html>`_ covering installation, datasets, and basic usage.
- Information about the `configuration arguments <usage/config.html>`_ available for running the models.
- Details on the `model zoo <usage/models.html>`_ of pre-packaged models, with the option to extend them.
- `Tutorials <tutorials/index.html>`_ with code examples to train and test hybrid hydrologic models.

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

   usage/getting_started
   usage/models
   usage/config
   tutorials/index
   contributing