API reference¶

Here we will add the documentation for selected modules.

Entity tasks¶

`define_glacier_region`	Very first task: define the glacier’s grid.
`glacier_masks`	Converts the glacier vector geometries to grids.
`compute_centerlines`	Compute the centerlines following Kienholz et al., (2014).
`compute_downstream_lines`	Compute the lines continuing the glacier (one per divide).
`catchment_area`	Compute the catchment areas of each tributary line.
`initialize_flowlines`	Transforms the geometrical Centerlines in the more “physical” InversionFlowlines.
`catchment_width_geom`	Compute geometrical catchment widths for each point of the flowlines.
`catchment_width_correction`	Corrects for NaNs and inconsistencies in the geometrical widths.
`mu_candidates`	Computes the mu candidates.
`prepare_for_inversion`	Prepares the data needed for the inversion.
`volume_inversion`	Computes the inversion the glacier.
`distribute_thickness`	Compute a thickness map of the glacier using the nearest centerlines.
`init_present_time_glacier`	First task after inversion.
`find_inital_glacier`	Search for the glacier in year y0

`distribute_climate_data`	Reads the climate data and distributes to each glacier.
`compute_ref_t_stars`	Detects the best t* for the reference glaciers.
`distribute_t_stars`	After the computation of the reference tstars, apply the interpolation to each individual glacier.
`optimize_inversion_params`	Optimizes fs and fd based on GlaThiDa thicknesses.

GlacierDirectory Organizes read and write access to the glacier’s files.

Mass-balance models in the oggm.core.models.massbalance module

`TstarMassBalanceModel`	Constant mass balance: equilibrium MB at period t*.
`BackwardsMassBalanceModel`	Constant mass balance: MB for [1983, 2003] with temperature bias.
`TodayMassBalanceModel`	Constant mass-balance: MB during the last 30 yrs.
`HistalpMassBalanceModel`	Mass balance during the HISTALP period.