.. _basement:

Basement
========

Osdyn provides readers and tools that make diagnostics implementation easy and allow to share them with different data sources.

Readers
-------

Readers of data files support NetCDF Climate and Forecast metadata convention but does not assume any specific information. In particular the COMODO convention (welcomed however) is not required.

The knowledge of the specificities of each NetCDF database is not mandatory as the user selects his variables of interest according to the osdyn nomenclature (osdyn key names). These generic variable names are used throughout the analyses. Such a design allows a generic implementation of diagnostics, regardless the data sources.

Osdyn key names
---------------

Key names are introduced
into the datasets thanks to `to_osdyn` methods.

Please find below a table describing the variable relative to each key name.

.. csv-table:: Table of osdyn key names
   :file: _static/osdyn_key_vars.csv
   :widths: 15, 40, 15
   :header-rows: 1

Sample selection
----------------

In order to reduce memory usage, sub-domains and periods are selected as soon as the dataset is read.

Parallelization
---------------

TODO

Diagnostics
-----------

Many generic functions adress the estimate of the main oceanographic features. They are depicted in the **osdyn.diags** part of the API.

Plots
-----

Although osdyn is not dedicated to plotting, many figures are available throughout the Gallery. They are static when based on matplotlib and cartopy modules but interactive when using the plotly package.