:notoc:

.. module:: smash

*******************
smash documentation
*******************

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

`smash` (**S**\patially distributed **M**\odelling and **AS**\similation for **H**\ydrology models) is an open-source Python library that provides a variety of user-friendly routines for hydrological modeling. It includes features such as data preprocessing, high-dimensional optimization tools, sensitivity and signatures analysis, all interfaced with an efficient Fortran solver.

.. grid:: 2

    .. grid-item-card::
        :img-top: _static/index_getting_started.svg
        
        Getting Started
        ^^^^^^^^^^^^^^^

        New to *smash*? Check out the getting started guides.

        +++

        .. button-ref:: getting_started
            :expand:
            :color: muted
            :click-parent:

            To the getting started
            
    .. grid-item-card::
        :img-top: _static/index_user_guide.svg

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

        The user guide provides in depth-information of the *smash* library.

        +++

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

            To the user guide
            
    .. grid-item-card::
        :img-top: _static/index_api.svg

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

        The reference guide contains a detailed description of
        the *smash* API.

        +++

        .. button-ref:: api_reference
            :expand:
            :color: muted
            :click-parent:

            To the api reference
            
    .. grid-item-card::
        :img-top: _static/index_math_num.svg

        Math / Num Documentation
        ^^^^^^^^^^^^^^^^^^^^^^^^

        The mathematical and numerical documentation contains a detailed description of
        the *smash* model operators.

        +++

        .. button-ref:: math_num_documentation
            :expand:
            :color: muted 
            :click-parent:

            To the math / num documentation

.. toctree::
   :maxdepth: 3
   :hidden:
   :titlesonly:
   
   getting_started/index
   user_guide/index
   api_reference/index
   math_num_documentation/index
   release/index
   contributors/index
   developers_guide/index
   license/index
   bibliography/index