oggm.core.massbalance.PastMassBalance

class oggm.core.massbalance.PastMassBalance(gdir, mu_star=None, bias=None, filename='climate_historical', input_filesuffix='', repeat=False, ys=None, ye=None, check_calib_params=True)[source]

Mass balance during the climate data period.

__init__(gdir, mu_star=None, bias=None, filename='climate_historical', input_filesuffix='', repeat=False, ys=None, ye=None, check_calib_params=True)[source]

Initialize.

Parameters:
gdir : GlacierDirectory

the glacier directory

mu_star : float, optional

set to the alternative value of mu* you want to use (the default is to use the calibrated value).

bias : float, optional

set to the alternative value of the calibration bias [mm we yr-1] you want to use (the default is to use the calibrated value) Note that this bias is substracted from the computed MB. Indeed: BIAS = MODEL_MB - REFERENCE_MB.

filename : str, optional

set to a different BASENAME if you want to use alternative climate data.

input_filesuffix : str

the file suffix of the input climate file

repeat : bool

Whether the climate period given by [ys, ye] should be repeated indefinitely in a circular way

ys : int

The start of the climate period where the MB model is valid (default: the period with available data)

ye : int

The end of the climate period where the MB model is valid (default: the period with available data)

check_calib_params : bool

OGGM will try hard not to use wrongly calibrated mu* by checking the parameters used during calibration and the ones you are using at run time. If they don’t match, it will raise an error. Set to False to suppress this check.

Attributes:
temp_bias : float, default 0

Add a temperature bias to the time series

prcp_bias : float, default 1

Precipitation factor to the time series (called bias for consistency with temp_bias)

Methods

__init__(gdir[, mu_star, bias, filename, …]) Initialize.
get_annual_climate(heights[, year]) Annual climate information at given heights.
get_annual_mb(heights[, year]) Like self.get_monthly_mb(), but for annual MB.
get_ela([year]) Compute the equilibrium line altitude for this year
get_monthly_climate(heights[, year]) Monthly climate information at given heights.
get_monthly_mb(heights[, year]) Monthly mass-balance at given altitude(s) for a moment in time.
get_specific_mb([heights, widths, fls, year]) Specific mb for this year and a specific glacier geometry.