OSDYN Notebooks
===============

Here are osdyn notebooks and its associated gallery that shows the available readers and diagnostics. They are examples for the user. Most of them can be used from other datasets, provided that the osdyn reader has been previously adaptated to this type of data.

At first, the :ref:`Database` section describes how the user can specify paths to his own data and how to create specific metadata files which will speed up the reading of the data sets. This functionality is recommanded for huge data sets but not a mandatory.

The second and third parts, :ref:`Models` and :ref:`Observations`, depict all of the available readers. A quick-overview is added to the model readers part.

The :ref:`Diagnostics` section is the most relevant for the user as it gives an overview of the available analyses.

Lastly, a section named :ref:`Tools` lists a few useful tools to handle the data.


.. toctree::
   :maxdepth: 1

   nb_osdyn_database
   nb_osdyn_models
   nb_osdyn_obs
   nb_osdyn_diags
   nb_osdyn_tools