.. Flood Modeller Python API documentation master file, created by
   sphinx-quickstart on Fri Jul 30 10:04:52 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. Icons used from Font Awesome, see licence at https://fontawesome.com/license

Welcome to Flood Modeller API's documentation!
=====================================================

Flood Modeller API is a python package which provides a bridge between 
`Flood Modeller <https://www.floodmodeller.com/>`_ and the python programming language 
to extend the capabilities of Flood Modeller in automated workflows.

.. grid:: 1 2 2 2
   :gutter: 2

   .. grid-item-card:: Getting Started
      :img-top: _static/getting_started.png
      :text-align: center

      If you're new to Flood Modeller Python API then this is the place to start.

      +++

      .. button-ref:: getting_started/index
         :color: secondary
         :ref-type: doc
         :expand:
         :click-parent:

         Get started

   .. grid-item-card:: User Guide
      :img-top: _static/user_guide.png
      :text-align: center

      A comprehensive guide to each of the main python classes, plus code reference and examples.

      +++

      .. button-ref:: user_guide/index
         :color: secondary
         :ref-type: doc
         :expand:
         :click-parent:

         Go to user guide

   .. grid-item-card:: Release Notes
      :img-top: _static/release_notes.png
      :text-align: center

      Details of the latest updates and features.

      +++

      .. button-ref:: release_notes/index
         :color: secondary
         :ref-type: doc
         :expand:
         :click-parent:

         Go to release notes

   .. grid-item-card:: Support and Feedback
      :img-top: _static/support.png
      :text-align: center

      Get support using Flood Modeller and Python, and help improve Flood Modeller Python API by providing feedback to the developers.

      +++

      .. button-ref:: support/index
         :color: secondary
         :ref-type: doc
         :expand:
         :click-parent:
         
         Support & Feedback


Contents
---------
.. toctree::
   :maxdepth: 3
   
   getting_started/index
   user_guide/index
   release_notes/index
   support/index