earthdiagnostics.ocean

earthdiagnostics.ocean.areamoc

Compute an Atlantic MOC index from the average

class earthdiagnostics.ocean.areamoc.AreaMoc(data_manager, startdate, member, chunk, basin, box)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute an Atlantic MOC index

Averages the meridional overturning in a latitude band between 1km and 2km or any other index averaging the meridional overturning in a given basin and a given domain

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

March 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • basin (Basin) – basin to compute
  • box (Box) – box to compute
alias = 'mocarea'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – minimum latitude, maximum latitude, minimum depth, maximum depth, basin=Global
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.averagesection

Compute an average of a given zone

class earthdiagnostics.ocean.averagesection.AverageSection(data_manager, startdate, member, chunk, domain, variable, box, grid)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute an average of a given zone.

The variable MUST be in a regular grid

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

March 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable’s name
  • domain (ModelingRealm) – variable’s domain
  • box (Box) – box to use for the average
alias = 'avgsection'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, minimum longitude, maximum longitude, minimum latitude, maximum latitude, domain=ocean
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.convectionsites

Compute the intensity of convection

class earthdiagnostics.ocean.convectionsites.ConvectionSites(data_manager, startdate, member, chunk, model_version)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the intensity of convection in the four main convection sites

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

October 2013
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • model_version (str) – model version
alias = 'convection'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.cutsection

Cut meridional or zonal sections

class earthdiagnostics.ocean.cutsection.CutSection(data_manager, startdate, member, chunk, domain, variable, zonal, value)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Cuts a meridional or zonal section

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

September 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable’s name
  • domain (Domain) – variable’s domain
  • zonal (bool) – specifies if section is zonal or meridional
  • value (int) – value of the section’s coordinate
alias = 'cutsection'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, zonal, value, domain=ocean
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.gyres

Compute the intensity of the subtropical and subpolar gyres

class earthdiagnostics.ocean.gyres.Gyres(data_manager, startdate, member, chunk, model_version)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the intensity of the subtropical and subpolar gyres

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

October 2013
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • model_version (str) – model version
alias = 'gyres'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.heatcontent

Compute the total ocean heat content

class earthdiagnostics.ocean.heatcontent.HeatContent(data_manager, startdate, member, chunk, basin, mixed_layer, box, min_level, max_level)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the total ocean heat content

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

May 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • mixed_layer (int) – If 1, restricts calculation to the mixed layer, if -1 exclude it. If 0, no effect
  • box (Box) – box to use for the average
alias = 'ohc'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – basin, mixed layer option (1 to only compute at the mixed layer, -1 to exclude it, 0 to ignore), minimum depth, maximum depth
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.heatcontentlayer

Point-wise Ocean Heat Content in a specified ocean thickness (J/m-2)

class earthdiagnostics.ocean.heatcontentlayer.HeatContentLayer(data_manager, startdate, member, chunk, box, weight, min_level, max_level)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Point-wise Ocean Heat Content in a specified ocean thickness (J/m-2)

Original author:
 

Isabel Andreu Burillo
Contributor:

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Eleftheria Exarchou <eleftheria.exarchou@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

June 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • box (Box) – box to use for the calculations
alias = 'ohclayer'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – minimum depth, maximum depth, basin=Global
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.interpolate

SCRIP based interpolation

class earthdiagnostics.ocean.interpolate.Interpolate(data_manager, startdate, member, chunk, domain, variable, target_grid, model_version, invert_lat, original_grid)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

3-dimensional conservative interpolation to the regular atmospheric grid.

It can also be used for 2D (i,j) variables

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

November 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable’s name
  • domain (Domain) – variable’s domain
  • model_version (str) – model version
alias = 'interp'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – target_grid, variable, domain=ocean
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.interpolatecdo

CDO-based interpolation

class earthdiagnostics.ocean.interpolatecdo.ComputeWeights(data_manager, startdate, member, chunk, domain, variable, target_grid, original_grid, weights_file, method)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Diagnostic used to compute interpolation weights

Parameters:
  • data_manager (DataManager) –
  • startdate (str) –
  • member (int) –
  • chunk (int) –
  • domain (ModelingRealm) –
  • variable (str) –
  • target_grid (str) –
  • original_grid (str) –
  • weights_file (str) –
  • method (str) –
alias = 'computeinterpcdoweights'

Diagnostic alias for the configuration file

compute()[source]

Compute weights

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Generate the instances of the diagnostics that will be run by the manager

This method does not does anything as this diagnostic is not expected to be called by the users

request_data()[source]

Request data required by the diagnostic

class earthdiagnostics.ocean.interpolatecdo.InterpolateCDO(data_manager, startdate, member, chunk, domain, variable, target_grid, model_version, mask_oceans, original_grid, weights)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

3-dimensional conservative interpolation to the regular atmospheric grid.

It can also be used for 2D (i,j) variables

Original author:
 

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

October 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable’s name
  • domain (ModelingRealm) – variable’s domain
  • model_version (str) – model version
alias = 'interpcdo'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

classmethod compute_weights(method, target_grid, sample_file, weights)[source]

Compute weights for interpolation from sample file

Parameters:
  • method (int) – Interpolation method
  • target_grid (str) – Grid to intepolate to. Can be anything understand by CDO
  • sample_file (str) – Path to a file containing original mesh information
  • weights – Path to the file to store the weights
declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – target_grid, variable, domain=ocean
Returns:
classmethod get_sample_grid_file()[source]

Get a sample grid file

Create a sample grid file from the definition in the masks file

Returns:
Return type:str
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.maskland

earthdiagnostics.ocean.maxmoc

Compute an Atlantic MOC index

class earthdiagnostics.ocean.maxmoc.MaxMoc(data_manager, startdate, member, year, basin, box)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute an Atlantic MOC index

It finds the maximum of the annual mean meridional overturning in a latitude / depth region

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

March 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • year (int) – year to compute
  • basin (Basin) – basin to compute
  • box (Box) – box to compute
alias = 'mocmax'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each complete year to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – minimum latitude, maximum latitude, minimum depth, maximum depth, basin=global
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.mixedlayerheatcontent

Compute mixed layer heat content

class earthdiagnostics.ocean.mixedlayerheatcontent.MixedLayerHeatContent(data_manager, startdate, member, chunk)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute mixed layer heat content

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

February 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
alias = 'mlotsthc'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.mixedlayersaltcontent

Compute mixed layer salt content

class earthdiagnostics.ocean.mixedlayersaltcontent.MixedLayerSaltContent(data_manager, startdate, member, chunk)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute mixed layer salt content

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

February 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
alias = 'mlotstsc'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.moc

Compute the MOC for oceanic basins

class earthdiagnostics.ocean.moc.Moc(data_manager, startdate, member, chunk)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the MOC for oceanic basins

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

March 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
alias = 'moc'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.mxl

Compute the mixed layer depth

class earthdiagnostics.ocean.mxl.Mxl(data_manager, startdate, member, chunk)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the mixed layer depth

Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
alias = 'mxl'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.psi

Compute the barotropic stream function

class earthdiagnostics.ocean.psi.Psi(data_manager, startdate, member, chunk)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the barotropic stream function

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

March 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
alias = 'psi'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – None
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.rotation

Rotate two u v variables to align with latitude and longitude

class earthdiagnostics.ocean.rotation.Rotation(data_manager, startdate, member, chunk, domain, variableu, variablev, executable)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Rotate two u v variables to align with latitude and longitude

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

September 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • domain (Domain) – variable’s domain
alias = 'rotate'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, zonal, value, domain=ocean
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.siasiesiv

Compute the sea ice extent , area and volume in both hemispheres or a specified region

class earthdiagnostics.ocean.siasiesiv.Siasiesiv(data_manager, startdate, member, chunk, masks, var_manager, data_convention, omit_vol)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Compute the sea ice extent , area and volume in both hemispheres or a specified region.

Parameters:
  • data_manager (DataManager) –
  • startdate (str) –
  • member (int) –
  • chunk (init) –
  • domain (ModellingRealm) –
  • variable (str) –
  • basin (list of Basin) –
  • mask (numpy.array) –
  • omit_vol (bool) –
alias = 'siasiesiv'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – basin
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.verticalgradient

Calculate the gradient between 2 ocean levels

class earthdiagnostics.ocean.verticalgradient.VerticalGradient(data_manager, startdate, member, chunk, variable, box)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Calculate the gradient between 2 ocean levels

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Eleftheria Exarchou <eleftheria.exarchou@bsc.es>
Contributor:

Javier Vegas-Regidor <javier.vegas@bsc.es>
Created:

February 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable to average
  • box (Box) – box used to restrict the vertical mean
alias = 'vgrad'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, minimum depth (level), maximum depth (level)
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.verticalmean

Chooses vertical level in ocean, or vertically averages between 2 or more ocean levels

class earthdiagnostics.ocean.verticalmean.VerticalMean(data_manager, startdate, member, chunk, variable, box)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Chooses vertical level in ocean, or vertically averages between 2 or more ocean levels

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Eleftheria Exarchou <eleftheria.exarchou@bsc.es>
Contributor:

Javier Vegas-Regidor <javier.vegas@bsc.es>
Created:

February 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable to average
  • box (Box) – box used to restrict the vertical mean
alias = 'vertmean'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, minimum depth (level), maximum depth (level)
Returns:
request_data()[source]

Request data required by the diagnostic

earthdiagnostics.ocean.verticalmeanmeters

Averages vertically any given variable

class earthdiagnostics.ocean.verticalmeanmeters.VerticalMeanMeters(data_manager, startdate, member, chunk, domain, variable, box, grid_point)[source]

Bases: earthdiagnostics.diagnostic.Diagnostic

Averages vertically any given variable

Original author:
 

Virginie Guemas <virginie.guemas@bsc.es>
Contributor:

Javier Vegas-Regidor<javier.vegas@bsc.es>
Created:

February 2012
Last modified:

June 2016
Parameters:
  • data_manager (DataManager) – data management object
  • startdate (str) – startdate
  • member (int) – member number
  • chunk (int) – chunk’s number
  • variable (str) – variable to average
  • box (Box) – box used to restrict the vertical mean
alias = 'vertmeanmeters'

Diagnostic alias for the configuration file

compute()[source]

Run the diagnostic

declare_data_generated()[source]

Declare data to be generated by the diagnostic

classmethod generate_jobs(diags, options)[source]

Create a job for each chunk to compute the diagnostic

Parameters:
  • diags (Diags) – Diagnostics manager class
  • options (list[str]) – variable, minimum depth (meters), maximum depth (meters)
Returns:
request_data()[source]

Request data required by the diagnostic