.. atiim documentation master file, created by
   sphinx-quickstart on Tue Dec 28 17:16:26 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

:notoc:

atiim documentation
===================

**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/crvernon/atiim>`_ |
`Issues & Ideas <https://github.com/crvernon/atiim/issues>`_ |
`Interactive Quickstarter <https://mybinder.org/v2/gh/crvernon/atiim/main?labpath=notebooks%2Fquickstarter.ipynb>`_

**atiim** is the Area-Time Inundatation Index Model and was created to address the challenge of rapidly characterizing spatiotemporally-complex inundation patterns in dynamic systems, such as estuarine tidal-fluvial environments.


.. panels::
   :card: + intro-card text-center
   :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex


   ---
   :img-top: _static/cognitive.svg

   Getting Started
   ^^^^^^^^^^^^^^^

   Get to know **atiim**.

   +++

   .. link-button:: getting_started
           :type: ref
           :text: What atiim is all about
           :classes: btn-block btn-secondary stretched-link

   ---
   :img-top: _static/education.svg

   User Guide
   ^^^^^^^^^^

   The user guide provides in-depth information on the key concepts of **atiim**.

   +++

   .. link-button:: user_guide
           :type: ref
           :text: To the user guide
           :classes: btn-block btn-secondary stretched-link

   ---
   :img-top: _static/api.svg

   API Reference
   ^^^^^^^^^^^^^

   A detailed description of the **atiim** API.

   +++

   .. link-button:: atiim
           :type: ref
           :text: To the reference guide
           :classes: btn-block btn-secondary stretched-link

   ---
   :img-top: _static/index_contribute.svg

   Contributing to atiim
   ^^^^^^^^^^^^^^^^^^^^^

   Report a bug or suggest a new feature.

   +++

   .. link-button:: contributing
           :type: ref
           :text: To the development guide
           :classes: btn-block btn-secondary stretched-link


.. toctree::
  :maxdepth: 2
  :hidden:

  getting_started
  user_guide
  modules
  contributing
  publications
  license