pyissm API Reference

pyISSM comprises five major sub-packages:

• pyissm.model - contains the central functionality, including the core Model() class and all model sub-classes.

• pyissm.tools - contains diverse tools for interacting with the ISSM Model object.

• pyissm.data - contains tailored tools for interacting with external datasets, including interpolation routines.

• pyissm.plot - contains tailored tools for visualising ISSM models.

• pyissm.analysis - contains tailored post-processing tools.

Model Class

pyISSM is developed around a central Model() class.

pyissm.model.Model()

High-level container for all components of an Ice-sheet and Sea-level System Model (ISSM) model.

Model sub-classes

Each ISSM model contains a series of sub-classes that define model components and parameters (e.g., mesh, geometry, etc.).

pyissm.model.classes

ISSM Model sub-classes and available parameterisations.

Model operations

Each ISSM model is constructed and parameterised using various model operations.

pyissm.model.bc	Tools for setting boundary conditions on ISSM models.
pyissm.model.execute	ISSM execution commands to handle model marshalling and execution.
pyissm.model.io	Functions for reading and writing ISSM models.
pyissm.model.mesh	Functions for building and interacting with an ISSM model mesh.
pyissm.model.param	Functions for parameterising ISSM models.

Tools

Utilities and helper functions for interacting with the ISSM Model() object.

pyissm.tools

Universal tools for interacting with ISSM Model objects.

Data

Function for interacting with external datasets and interpolation routines.

pyissm.data

Data management and interpolation tools for ISSM models.

Plot

Visualisation utilities, including plotting of model meshes, boundary conditions, fields, and results.

pyissm.plot

Analysis

Post-processing tools for analysing ISSM models, including derived fields and metrics.

pyissm.analysis

Post-processing tools for ISSM models.