.. saco documentation master file, created by
   sphinx-quickstart on Thu Jan 30 15:36:07 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

SACO Documentation
==================

Welcome to the documentation for the Sustainable Abstraction Calculator and Optimiser
(SACO) tool.

The SACO tool aims to help identify potential ways to meet environmental flow targets
in Water Framework Directive (WFD) surface waterbodies. It has been developed by the
Environment Agency (England).

See the `release notes`_ in the repository for details of changes between package
versions.

.. _release notes: https://github.com/Environment-Agency-Gov/saco-core/releases


.. toctree::
   :maxdepth: 1
   :caption: Background:

   overview.rst
   data.rst
   calculator.rst
   optimiser.rst
   tutorial.rst


.. toctree::
   :maxdepth: 1
   :caption: Reference:

   fields.rst
   reference-dataset.rst
   reference-calculate.rst
   reference-optimise.rst