.. HydroWizard documentation master file, created by
   sphinx-quickstart on Thu Aug  1 18:28:48 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

HydroWizard Documentation
=========================

HydroWizard is a powerful and flexible tool designed to model, optimize, and simulate operations of any water resource system quickly and efficiently.

`View on GitHub <https://github.com/yugdeep/hydrowizard>`_

Features
--------

- **Automatic Modeling**: HydroWizard automatically creates a model for any river basin specified in a user-friendly YAML file.
- **Optimization**: Find Pareto optimal policy functions using advanced multi-objective optimization techniques.
- **Simulation**: Simulate flows and stocks over time to assess system performance under various scenarios.

Contents
--------

.. toctree::
   :maxdepth: 2

   simulate
   optimize
   modules
   license


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`