oggm.diagnostics.compute_spinup#
- oggm.diagnostics.compute_spinup(prun, reference_period=None)[source]#
How the dynamic spinup and the dynamic melt_f calibration went.
Two independent sources, and they do not say the same thing:
used_spinup_option, from the glacier statistics, is the outcome of the melt_f calibration: whether it converged, and what the fallback chain had to settle for. See SPINUP_OPTIONS.
is_fixed_geometry_spinup, from the run output itself, is what the series actually contains, year by year: it is True wherever the glacier geometry is held fixed because the dynamic model had not started yet.
The second is the honest measure of “did the spinup do what was asked”, and it is worse than the first suggests: when a dynamic spinup does not converge over the requested period, it is retried over shorter ones, and the years before the shortened period are filled with a fixed geometry spinup. Such a glacier is still labelled a full success, because the melt_f calibration did succeed - but its early years are not dynamic. is_fixed_geometry_spinup also survives a glacier whose statistics were not written, so it covers glaciers used_spinup_option knows nothing about.
- Parameters:
- prunPreproRun
the run to diagnose
- reference_periodstr, optional
the geodetic period, e.g. ‘2000-01-01_2020-01-01’. Used to report whether the fixed geometry part of the spinup still reaches into the period the mass balance is evaluated over. Defaults to cfg.PARAMS[‘geodetic_mb_period’].
- Returns:
- a DataFrame indexed by region, with a global row.