Read the data sets
^^^^^^^^^^^^^^^^^^

This part details three different ways to read outputs of ocean, atmosphere, and wave models. The :ref:`generic` method is very usefull but is even accelerated by the optional call of the :ref:`intake` description. The generic reading, from **moawi** command, calls classes dedicated to the reading of Mesonh, WW3, Mars, Nemo, Croco, Symphonie... outputs. All these classes can be called directly by the user (:ref:`specific` way). Nevertheless, the recommanded method is the **generic** one  with **intake**.


  1. Please use the **generic** reader **moawi** to allow further sharing of scientific diagnostics.

.. toctree::
   :maxdepth: 3

   notebooks/osdyn/models/moawi

.. _intake:

  2. To speed up the creation of the dataset, call **get_intake_dataset** at first. The use of that booster requires a specific description of the model outputs.
(see :ref:`preprocess`).

.. ipython:: python

    import os

TODO

  3. Lastly come the **specific** methods relative to each type of datasets.

.. warning:: The use of these classes induces a lost of genericity (introduced by the global reader **moawi** whichs call the specific methods). Consequently **moawi** method is THE METHOD (along with *intake* option).

This part is available for users who want to get details on the different ways to access the model data sets.

.. toctree::
   :maxdepth: 3

   notebooks/osdyn/models/mars_read
   notebooks/osdyn/models/mesonh_read
   notebooks/osdyn/models/ww3_read