.. image:: ../../img/Floodwater_logo_transparent.png

========================================
Floodwater Forecast System Documentation
========================================

Floodwater is a modern and extensible forecasting system
for use with hydrodynamic models. Floodwater has been designed to
operate in high performance computing environments and works in tandem
with the `MetGet <https://github.com/waterinstitute/metget>`_ system. The
system utilizes the ecFlow workflow controller and has been tested on
large NSF funded supercomputers, small clusters, and within cloud computing
environments.

Floodwater is developed under the terms of the Apache License 2.0.

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

    system_overview.rst
    getting_started.rst
    configuration_files.rst
    command_line_interface.rst
    runtime_options.rst
    current_users.rst
    acknowledgements.rst
    developer_guide.rst