oggm.core.massbalance.RandomMassBalance

class oggm.core.massbalance.RandomMassBalance(gdir, mu_star=None, bias=None, y0=None, halfsize=15, seed=None, filename='climate_historical', input_filesuffix='', all_years=False, unique_samples=False, prescribe_years=None, **kwargs)[source]

Random shuffle of all MB years within a given time period.

This is useful for finding a possible past glacier state or for sensitivity experiments.

Note that this is going to be sensitive to extreme years in certain periods, but it is by far more physically reasonable than other approaches based on gaussian assumptions.

__init__(gdir, mu_star=None, bias=None, y0=None, halfsize=15, seed=None, filename='climate_historical', input_filesuffix='', all_years=False, unique_samples=False, prescribe_years=None, **kwargs)[source]

Initialize.

Parameters
gdirGlacierDirectory

the glacier directory

mu_starfloat, optional

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

biasfloat, 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.

y0int, optional, default: tstar

the year at the center of the period of interest. The default is to use tstar as center.

halfsizeint, optional

the half-size of the time window (window size = 2 * halfsize + 1)

seedint, optional

Random seed used to initialize the pseudo-random number generator.

filenamestr, optional

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

input_filesuffixstr

the file suffix of the input climate file

all_yearsbool

if True, overwrites y0 and halfsize to use all available years.

unique_samples: bool

if true, chosen random mass-balance years will only be available once per random climate period-length if false, every model year will be chosen from the random climate period with the same probability

prescribe_yearspandas Series

instead of random samples, take a series of (i, y) pairs where (i) is the simulation year index and (y) is the year to pick in the original timeseries. Overrides y0, halfsize, all_years, unique_samples and seed.

**kwargs:

kyeword arguments to pass to the PastMassBalance model

Methods

__init__(gdir[, mu_star, bias, y0, ...])

Initialize.

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_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.

get_state_yr([year])

For a given year, get the random year associated to it.

Attributes

bias

Residual bias to apply to the original series.

prcp_bias

prcp_fac

Precipitation factor to apply to the original series.

temp_bias

Temperature bias to add to the original series.