pyissm.analysis.ismip

ISMIP-related functions for ISSM

This module contains functions for handling ISMIP-related data and operations.

Functions

calc_perc_ice_cover(total_ice_area, ice_area)

Calculate the percentage ice cover, relative to the of total ice area.

get_ismip_variable(md, ismip_variable_name)

Retrieve a specific ISMIP variable from a model object.
pyissm.analysis.ismip.calc_perc_ice_cover(total_ice_area, ice_area)

Calculate the percentage ice cover, relative to the of total ice area.

This function computes the fraction of the ice area that is grounded (i.e., not floating). The result is returned as a percentage.

Parameters:

  • total_ice_area (ndarray) – Array representing the total ice area.

  • ice_area (ndarray) – Array representing the ice area for percentage coverage to be computed.

Returns:

ice_area_perc – Array with the same shape as ice_area, where each element represents the percentage of the total_ice_area that is covered by the ice_area.

Return type:

ndarray

pyissm.analysis.ismip.get_ismip_variable(md, ismip_variable_name)

Retrieve a specific ISMIP variable from a model object.

This function extracts and calculates a requested ISMIP (Ice Sheet Model Intercomparison Project) variable from a given model object, if the necessary data is available. It supports area-based variables calculated from grounded and floating ice components stored in the model’s transient solution.

Parameters:

  • md (object) – The model object containing transient solution results, typically with attributes like md.results.TransientSolution.GroundedArea and FloatingArea.

  • ismip_variable_name (str) – Name of the ISMIP variable to compute. Must be one of: - ‘land_ice_area_fraction’ (assumes all ice in ISSM is land ice and returns 100 %) - ‘floating_ice_shelf_area_fraction’ - ‘grounded_ice_sheet_area_fraction’

Returns:

variable – The computed variable as a percentage, or None if the required data is not available in the model object.

Return type:

array-like or None

Raises:

None explicitly, but prints a warning if the requested variable cannot be computed. –

Notes

  • ‘land_ice_area_fraction’ assumes all ice is land ice (returns 100% where data is available).

  • ‘floating_ice_shelf_area_fraction’ computes the fraction of total ice that is floating.

  • ‘grounded_ice_sheet_area_fraction’ computes the fraction of total ice that is grounded.

  • Missing required attributes in md will result in the variable being skipped.