OSDYN : Observations and Simulations of the DYNamics
====================================================

**osdyn** is a Python library that proposes diagnostics and tools to
explore the dynamics of the ocean and its interactions with the atmosphere and waves.

.. .. note:: the logo was made from a photo extracted from the following `gregr's <http://gregr.fr>`__ blog.

.. osdyn is dedicated to several type of observations
.. modeles, observations lister quad bcq

It is particularly suited for working with netCDF_ files, which are read from
xarray_ and dask_ packages. Variables in Xarray datasets are renamed, sometimes slightly
modified to match with osdyn conventions.
These slight modifications allow scientists to focus on the diagnostics themselves and directly develop scripts adapted to different datasets. The sharing of analysis methods is greatly simplified.

.. _xarray: http://xarray.pydata.org
.. _dask: http://dask.org
.. _netCDF: http://www.unidata.ucar.edu/software/netcdf

Documentation
-------------

**Description**

* :doc:`why-osdyn`
* :doc:`basement`

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Description

   why-osdyn
   basement

**Getting Ready**

* :doc:`installing`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Getting Ready

   installing

**User Guide**

* :doc:`quick-overview`
* :doc:`nbs`

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: User Guide

   quick-overview
   nbs
   notebooks/index

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Gallery

   ngo_model
   ngo_obs
   ngo_diags
   ngu_plot

**Help & reference**

.. * :doc:`whats-new`

* :doc:`roadmap`
* :doc:`contributing`

.. toctree::
   :maxdepth: 3
   :hidden:
   :caption: Help & reference

   roadmap
   contributing

.. toctree::
   :maxdepth: 1

   api

**Indices and tables**

* :ref:`genindex`
* :ref:`modindex`


See also
--------

Xarray tutorials

- The `UW eScience Institute's Geohackweek`_ tutorial on xarray for geospatial data scientists.
- Stephan Hoyer's `SciPy2015 talk`_ introducing xarray to a general audience.
- Stephan Hoyer's `2015 Unidata Users Workshop talk`_
- `Nicolas Fauchereau's tutorial`_ on xarray for netCDF users.

.. _UW eScience Institute's Geohackweek : https://geohackweek.github.io/nDarrays/
.. _SciPy2015 talk: https://www.youtube.com/watch?v=X0pAhJgySxk
.. _2015 Unidata Users Workshop talk: https://www.youtube.com/watch?v=J9ypQOnt5l8
.. _Nicolas Fauchereau's tutorial: http://nbviewer.iPython.org/github/nicolasfauchereau/metocean/blob/master/notebooks/xray.ipynb

Xoa tutorials

License
-------

.. osdyn is available under

.. the open source `Apache License`__.

.. http://www.apache.org/licenses/LICENSE-2.0.html

References
----------