.. _user_guide:

==========
User Guide
==========

Getting started with the `smash` package can be done by following all the ``Quickstart`` sections below. The different cases will call upon the major part of the available tools. In order not to overload the cases, additional and more precise information can be found in the ``In Depth`` section.  
Most of the time, references to the in depth section are made in the cases allowing to go further on specific methods by following the implementation of a distributed hydrological simulation with `smash`. 

Quickstart
**********
.. toctree::
    :maxdepth: 1

    quickstart/practice_case
    quickstart/real_case_cance
    quickstart/real_case_france

In Depth
********
.. toctree::
    :maxdepth: 2

    in_depth/optimize/index

.. toctree::
    :maxdepth: 1

    in_depth/multiple_run
    in_depth/automatic_meshing
    in_depth/event_segmentation
    in_depth/signatures
    in_depth/prcp_indices

Others
******
.. toctree::
    :maxdepth: 1

    others/model_initialization
    others/model_structure
    others/model_input_data_convention