API

This page is a summary of the most important classes and methods of pyGMS. For a full list of modules please refer to the Module Index.

Classes

The classes of pyGMS are:

GMS([filename, triangulate, verbosity])	The main class of pyGMS.
Well(x, y, z)	A class representing a vertical well in a GMS model.
Layer(x, y, z, layer_id[, name])	A class representing a layer.

Computing methods

Thermal field

GMS.compute_surface_heat_flow([…])

Compute the surface heat flow of the model.

Rheology

GMS.compute_bd_thickness([dx, nz, mode, …])	Compute the brittle and ductile thicknesses of all layers.
GMS.compute_elastic_thickness([dx, nz, …])	Compute the effective elastic thickness of the model.
GMS.compute_integrated_strength([nz, …])	Compute the integrated strength of the model.
GMS.compute_yse(well[, mode, nz, …])	Compute yield strength envelopes and associated variables.

Visualisation

Profiles

GMS.plot_profile(x0, y0, x1, y1[, var, num, …])	Plot a profile.
GMS.plot_layer_bounds(x0, y0, x1, y1[, num, …])	Plot the layer tops in profile view.
GMS.plot_strength_profile(x0, y0, x1, y1[, …])	Compute and plot an arbitrary yield strength profile.
GMS.plot_strength_profile(x0, y0, x1, y1[, …])	Compute and plot an arbitrary yield strength profile.
GMS.plot_yse(loc[, strain_rate, mode, nz, …])	Plot a yield strength envelope of a well or an x,y coordinate.

Maps

GMS.plot_topography([ax])	Plot the topography.
GMS.plot_surface_heat_flow(**kwds)	Plot a surface heat flow map.

Wells

Well.plot_var(varname[, ax])	Plot a variable.
Well.plot_grad(varname[, scale, …])	Plot the gradient of a variable.