Ripple1D
========

**Version**: |version|

.. note::
   This version is tagged as **testing**. Features and APIs are subject to change.

:code:`ripple1d` is a Python utility that repurposes HEC-RAS models for use in
the production of Flood Inundation Maps (FIMs) and synthetic rating curves
(SRCs) to support near-real-time flood forecasting within NOAA’s National Water
Model (NWM).

Navigating the documentation
-----------------------------

.. grid:: 1 1 2 2
    :gutter: 2 3 4 4

    .. grid-item-card::
        :text-align: center

        **For a high level overview**
        ^^^

        The Technical Summary provides an overview of the purpose and
        functionality of ripple1d.

        +++

        .. button-ref:: tech_summary
            :expand:
            :color: secondary
            :click-parent:

            To the Technical Summary

    .. grid-item-card::
        :text-align: center

        **For Frequently Asked Questions**
        ^^^

        The FAQ provides quick answers to quick questions.

        +++

        .. button-ref:: faq
            :expand:
            :color: secondary
            :click-parent:

            To the FAQ

    .. grid-item-card::
        :text-align: center

        **For user instructions**
        ^^^

        The User Guide provides information on how to start the ripple1d server
        and submit jobs.

        +++

        .. button-ref:: user_guide
            :expand:
            :color: secondary
            :click-parent:

            To the User Guide

    .. grid-item-card::
        :text-align: center

        **For examples**
        ^^^

        The Postman Collection provides an easy way to explore the ripple1d
        endpoints.

        +++

        .. button-ref:: postman
            :expand:
            :color: secondary
            :click-parent:

            To the Postman Collection

.. toctree::
   :maxdepth: 1
   :hidden:

   Technical Summary <tech_summary.rst>
   FAQ <faq.rst>
   User Guide <user_guide.rst>
   Postman Collection <postman.rst>
   Change Log <change_log.rst>
   API Reference <api_reference.rst>