oggm.workflow.calibrate_inversion_from_consensus

oggm.workflow.calibrate_inversion_from_consensus#

oggm.workflow.calibrate_inversion_from_consensus(gdirs, settings_filesuffix='', observations_filesuffix='', overwrite_observations=False, input_filesuffix=None, output_filesuffix=None, ignore_missing=True, fs=0, a_bounds=(0.1, 10), apply_fs_on_mismatch=False, error_on_mismatch=True, filter_inversion_output=True, ref_volume_m3=None, ref_volume_year=None, add_to_log_file=True)[source]#

Fit the total volume of the glaciers to the 2019 consensus estimate.

Deprecated since version Use: calibrate_inversion_from_ref_table() instead, which supports more recent reference volume products. This function is kept for backwards compatibility and keeps calibrating against the Farinotti et al. (2019) consensus estimate.

This method finds the “best Glen A” to match all glaciers in gdirs with a valid inverted volume.

Parameters:
gdirslist of oggm.GlacierDirectory objects

the glacier directories to process

settings_filesuffix: str

You can use a different set of settings by providing a filesuffix. This is useful for sensitivity experiments.

observations_filesuffix: str

You can provide a filesuffix for the reference volume to use. If you provide ref_volume_m3, then this values will be stored in the observations file, if ref_volume_m3 is not already present. If you want to force to use the provided values and override the current ones, set overwrite_observations to True.

overwrite_observationsbool

If you want to overwrite already existing observation values in the provided observations file set this to True. If this is False the volumes saved in the observation file are used as the reference. Default is True.

input_filesuffix: str

The filesuffix of the input inversion flowlines. If None the settings_filesuffix will be used.

output_filesuffix: str

The filesuffix used for saving resulting inversion files to the gdir. If None the settings_filesuffix will be used.

ignore_missingbool

set this to true to silence the error if some glaciers could not be found in the consensus estimate.

fsfloat

invert with sliding (default: no)

a_bounds: tuple

factor to apply to default A

apply_fs_on_mismatch: false

on mismatch, try to apply an arbitrary value of fs (fs = 5.7e-20 from Oerlemans) and try to optimize A again.

error_on_mismatch: bool

sometimes the given bounds do not allow to find a zero mismatch: this will normally raise an error, but you can switch this off, use the closest value instead and move on.

filter_inversion_outputbool

whether or not to apply terminus thickness filtering on the inversion output (needs the downstream lines to work).

ref_volume_m3float

Option to give an own total glacier volume to match to

ref_volume_yearint or None

The year when the reference volume is valid. If None the RGI date is used.

add_to_log_filebool

if the called entity tasks should write into log of gdir. Default True

Returns:
a dataframe with the individual glacier volumes