pyissm.model.classes.dsl

Dynamic Sea Level (DSL) classes for ISSM.

Classes

default([other])

Default DSL class for ISSM.

mme([other])

Multi-Model Ensemble (MME) DSL class for ISSM.
class pyissm.model.classes.dsl.default(other=None)

Bases: manage_state

Default DSL class for ISSM.

This class contains the default parameters for dynamic sea level (DSL) in the ISSM framework. It defines the main DSL-related parameters.

Parameters:

other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

global_average_thermosteric_sea_level

Corresponds to zostoga field in CMIP5 archives. Specified as a temporally variable quantity (in m).

Type:

float or numpy.ndarray, default=np.nan

sea_surface_height_above_geoid

Corresponds to zos field in CMIP5 archives. Spatial average is 0. Specified as a spatio-temporally variable quantity (in m).

Type:

float or numpy.ndarray, default=np.nan

sea_water_pressure_at_sea_floor

Corresponds to bpo field in CMIP5 archives. Specified as a spatio-temporally variable quantity (in m equivalent, not in Pa!).

Type:

float or numpy.ndarray, default=np.nan

Examples

>>> md.dsl = pyissm.model.classes.dsl.default()
check_consistency(md, solution, analyses)

Check consistency of the [dsl.default] parameters.

Parameters:

  • md (pyissm.model.Model) – The model object to check.

  • solution (str) – The solution name to check.

  • analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

initialize(md)

Initialise [dsl.default] empty fields.

If current values of required fields are np.nan, they will be set to default required shapes/values and warnings will be issued.

Examples

>>> md.dsl = pyissm.model.classes.dsl.default()
# At this point, initial fields are np.nan
# After calling initialize, they will be set to default shapes/values with warnings issued.
>>> md.dsl.initialize(md)
marshall_class(fid, prefix, md=None)

Marshall [dsl.default] parameters to a binary file.

Parameters:

  • fid (file object) – The file object to write the binary data to.

  • prefix (str) – Prefix string used for data identification in the binary file.

  • md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None

class pyissm.model.classes.dsl.mme(other=None)

Bases: manage_state

Multi-Model Ensemble (MME) DSL class for ISSM.

This class conatins the parameters for dynamic sea level (DSL) for a multi-model ensemble (MME) of CMIP5 outputs in the ISSM framework. It defines the main DSL-related parameters for each ensemble member.

Parameters:

other (any, optional) – Any other class object that contains common fields to inherit from. If values in other differ from default values, they will override the default values.

modelid

Index into the multi-model ensemble, determines which field will be used.

Type:

int, default=0

global_average_thermosteric_sea_level

Corresponds to zostoga field in CMIP5 archives. Specified as a temporally variable quantity (in m) for each ensemble member.

Type:

float or numpy.ndarray, default=np.nan

sea_surface_height_above_geoid

Corresponds to zos field in CMIP5 archives. Spatial average is 0. Specified as a spatio-temporally variable quantity (in m) for each ensemble member.

Type:

float or numpy.ndarray, default=np.nan

sea_water_pressure_at_sea_floor

Corresponds to bpo field in CMIP5 archives. Specified as a spatio-temporally variable quantity (in m equivalent, not in Pa!) for each ensemble member.

Type:

float or numpy.ndarray, default=np.nan

Examples

>>> md.dsl = pyissm.model.classes.dsl.mme()
check_consistency(md, solution, analyses)

Check consistency of the [dsl.mme] parameters.

Parameters:

  • md (pyissm.model.Model) – The model object to check.

  • solution (str) – The solution name to check.

  • analyses (list of str) – List of analyses to check consistency for.

Returns:

md – The model object with any consistency errors noted.

Return type:

pyissm.model.Model

marshall_class(fid, prefix, md=None)

Marshall [dsl.mme] parameters to a binary file.

Parameters:

  • fid (file object) – The file object to write the binary data to.

  • prefix (str) – Prefix string used for data identification in the binary file.

  • md (pyissm.model.Model, optional) – ISSM model object needed in some cases.

Return type:

None