.. WaterPaths documentation master file, created by
   sphinx-quickstart on Wed Jan  8 13:25:28 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the official WaterPaths documentation!
=================================================

.. warning::

   This site is a work in progress. If you see any mistakes or would like to request any additional material, please submit a new `Issue on GitHub <https://github.com/lbl59/WaterPaths-doc/issues>`_.

**WaterPaths** is a C++ package for the optimization of multi-actor water distribution systems under deep uncertainty. It is a utility planning and management tool built to facilitate the identification of regionally-robust
water supply planning and management policy pathways. To view its associated publication, please see `Trindade et al, 2020 <https://www.sciencedirect.com/science/article/pii/S1364815220301511>`_.

Install and Run
================

To install and run WaterPaths, clone this `GitHub Repository <https://github.com/bernardoct/WaterPaths>`_. Follow the directions in the corresponding README to run a simple WaterPaths simulation.

Modules
=======
.. toctree::
   :maxdepth: 1

   Continuity Models <ContinuityModels/ContinuityModels_index>
   Controls <Controls/Controls_index>
   Data Collector <DataCollector/DataCollector_index>
   Drought Mitigation Instruments <DroughtMitigationInstruments/DroughtMitigationInstruments_index>
   Problem Implementations <Problem/Problem_index>
   Simulation <Simulation/Simulation_index>
   System Components <SystemComponents/SystemComponents_index>
   Utils <Utils/Utils_index>