Diagnostic list
===============

In this section you have a list of the available diagnostics, with a small description of each one and a link to
the full documentation. To see what options are available for each diagnostic, see generate_jobs' documentation.

Remember that diagnostics are specified separated by spaces while options are given separated by commas:

.. code-block:: ini

    DIAGS = diag1 diag2,option1,option2 diag3


General
-------

- monmean:
    Calculates the monthly mean of the given variable.
    See :class:`~earthdiagnostics.general.monthlymean.MonthlyMean`

- relink:
    Regenerates the links created in the monthly_mean, daily_mean,   folders.
    See :class:`~earthdiagnostics.general.relink.Relink`

- rewrite:
    Just rewrites the CMOR output of a given variable. Useful to correct metadata or variable units.
    See :class:`~earthdiagnostics.general.rewrite.Rewrite`

Ocean
-----
- areamoc:
    Compute an Atlantic MOC index. See :class:`~earthdiagnostics.ocean.areamoc.AreaMoc`

- averagesection:
    Compute an average of a given zone. The variable MUST be in a regular grid
    See :class:`~earthdiagnostics.ocean.averagesection.AverageSection`

- convectionsites:
    Compute the intensity of convection in the four main convection sites.
    See :class:`~earthdiagnostics.ocean.convectionsites.ConvectionSites`

- cutsection:
    Cuts a meridional or zonal section. See :class:`~earthdiagnostics.ocean.cutsection.CutSection`

- gyres:
    Compute the intensity of the subtropical and subpolar gyres. See :class:`~earthdiagnostics.ocean.gyres.Gyres`

- heatcontent:
    Compute the total ocean heat content. See :class:`~earthdiagnostics.ocean.heatcontent.HeatContent`

- heatcontentlayer:
    Point-wise Ocean Heat Content in a specified ocean thickness.
    See :class:`~earthdiagnostics.ocean.heatcontentlayer.HeatContentLayer`

- interpolate:
    3-dimensional conservative interpolation to the regular atmospheric grid.
    It can also be used for 2D (i,j) variables. See :class:`~earthdiagnostics.ocean.interpolate.Interpolate`

- interpolateCDO:
    Bilinear interpolation to a given grid using CDO. See :class:`~earthdiagnostics.ocean.interpolatecdo.InterpolateCDO`

- maxmoc:
    Compute an Atlantic MOC index by finding the maximum  of the annual mean meridional overturning in a
    latitude / depth region See :class:`~earthdiagnostics.ocean.maxmoc.MaxMoc`

- mixedlayerheatcontent:
    Compute mixed layer heat content.
    See :class:`~earthdiagnostics.ocean.mixedlayerheatcontent.MixedLayerHeatContent`

- mixedlayersaltcontent:
    Compute mixed layer salt content. See
    :class:`~earthdiagnostics.ocean.mixedlayersaltcontent.MixedLayerSaltContent`

- moc:
    Compute the MOC for oceanic basins. See :class:`~earthdiagnostics.ocean.moc.Moc`

- psi:
    Compute the barotropic stream function. See :class:`~earthdiagnostics.ocean.psi.Psi`

- siasiesiv:
    Compute the sea ice extent , area and volume  in both hemispheres or a specified region.
    See :class:`~earthdiagnostics.ocean.siasiesiv.Siasiesiv`

- verticalmean:
    Chooses vertical level in ocean, or vertically averages between 2 or more  ocean levels.
    See :class:`~earthdiagnostics.ocean.verticalmean.VerticalMean`

- verticalmeanmeters:
    Averages vertically any given variable.
    See :class:`~earthdiagnostics.ocean.verticalmeanmeters.VerticalMeanMeters`