oggm-edu python package#

This page lists all classes, their methods and attributes available in the oggm-edu python package.

badge_edu_notebooks

Open a MyBinder interactive session to try them yourself!

Important

This programming interface is relatively new (2022). It replaces a much simpler previous interface, which is still accessible to our users with:

from oggm_edu import legacy

Don’t hesitate to let us know if you find any mistakes in the tool or in the docs!

GlacierBed#

GlacierBed([top, bottom, width, altitudes, ...])

The glacier bed used to construct a oggm_edu.Glacier.

GlacierBed.plot()

Plot the bed

GlacierBed example#

In [1]: from oggm_edu import GlacierBed

In [2]: bed = GlacierBed(top=3400, bottom=1500, width=300)

In [3]: bed.plot();
_images/plot_bed.png

MassBalance#

MassBalance(ela, gradient[, breakpoints, ...])

Oggm Edu mass balance, used to construct the oggm_edu.Glacier.

MassBalance.reset()

Reset the mass balance to initial state.

MassBalance.get_monthly_mb(heights, **kwargs)

Calculate the monthly mass balance for the glacier.

MassBalance.get_annual_mb(heights, **kwargs)

Get the annual mass balance.

MassBalance.gradient

Mass balance altitude gradient, mm/m.

MassBalance.ela

Altitude of the equilibrium line altitude (m).

MassBalance.temp_bias

Current temperature bias applied to the mass balance (unit: °C)

MassBalance example#

In [4]: from oggm_edu import MassBalance

In [5]: mass_balance = MassBalance(ela=3000, gradient=4)

In [6]: mass_balance
Out[6]: 
Glacier mass balance 
ELA [m]: 3000 
Original ELA [m]: 3000 
Temperature bias [C]: 0 
Gradient [mm/m/yr]: [4] 
Hemisphere: nh 
Ice density [kg/m3]: 900.0 

Glacier#

Glacier(bed, mass_balance)

Provides the user with an easy way to create and perform experiments on simulated glaciers.

Glacier methods#

Glacier.reset()

Reset the glacier to initial state.

Glacier.copy()

Return a copy of the glacier.

Glacier.progress_to_year(year)

Progress the glacier to year n.

Glacier.progress_to_equilibrium([years, t_rate])

Progress the glacier to equilibrium.

Glacier.plot()

Plot the current state of the glacier.

Glacier.plot_mass_balance()

Plot the mass balance profile of the glacier.

Glacier.plot_history()

Plot the history of the glacier.

Glacier.plot_state_history([interval, eq_states])

Plot the state history of the glacier (thicknesses) at specified intervals.

Glacier.add_temperature_bias(bias, duration)

Add a temperature bias to the mass balance of the glacier.

Glacier attributes#

Glacier.ela

Expose the mass balance ela for the glacier.

Glacier.mb_gradient

Expose the mass balance gradient.

Glacier.mass_balance

Glacier mass balance.

Glacier.annual_mass_balance

The annual mass balance at each grid point of the glacier.

Glacier.specific_mass_balance

The specific mass balance of the glacier [m w.e.

Glacier.age

Set the age of the glacier.

Glacier.history

The history of the glacier.

Glacier.state_history

The state history of the glacier, i.e. geometrical changes over time.

Glacier.creep

Set the value for glen_a creep

Glacier.basal_sliding

Set the sliding parameter of the glacier

Glacier.eq_states

Glacier equilibrium states.

Glacier.response_time

The response time of the glacier.

Glacier.current_state

For advanced users: get access to the current OGGM Flowline object.

Glacier example#

In [7]: from oggm_edu import Glacier

In [8]: glacier = Glacier(bed=bed, mass_balance=mass_balance)

In [9]: glacier.progress_to_equilibrium()

In [10]: glacier.plot();
_images/plot_glacier.png
In [11]: glacier.plot_history();
_images/plot_glacier_equi.png

SurgingGlacier#

SurgingGlacier([bed, mass_balance])

A surging glacier.

SurgingGlacier.reset()

Reset the state of the surging glacier.

SurgingGlacier.progress_to_year(year)

Progress the surging glacier to specified year.

SurgingGlacier.plot_history()

Plot the history of the surging glacier.

SurgingGlacier.normal_years

Number of years that the glacier progress without surging.

SurgingGlacier.surging_years

Number of years that the glacier progress during surges.

SurgingGlacier.basal_sliding_surge

GlacierCollection#

GlacierCollection([glacier_list])

This is an object used to store multiple glaciers.

GlacierCollection methods#

GlacierCollection.reset()

Reset all glaciers in the collection

GlacierCollection.fill(glacier, n[, ...])

Fill the collection with a desired number of glaciers.

GlacierCollection.add(glacier)

Adds one or more glaciers to the collection.

GlacierCollection.change_attributes(...)

Change the attribute(s) of the glaciers in the collection.

GlacierCollection.progress_to_year(year)

Progress the glaciers within the collection to the specified year.

GlacierCollection.progress_to_equilibrium([...])

Progress the glaciers to equilibrium.

GlacierCollection.plot()

Plot the glaciers in the collection to compare them.

GlacierCollection.plot_history()

Plot the histories of the collection.

GlacierCollection.plot_mass_balance()

Plot the mass balance(s) for the glaciers in the collection.

GlacierCollection attributes#

GlacierCollection.glaciers

Glaciers stored in the collection

GlacierCollection.annual_mass_balance

Glaciers mass balances

GlacierCollection example#

In [12]: from oggm_edu import GlacierCollection

In [13]: wide_narrow_bed = GlacierBed(altitudes=[3400, 2800, 1500],
   ....:                              widths=[600, 300, 300])
   ....: 

In [14]: wide_narrow_glacier = Glacier(bed=wide_narrow_bed,
   ....:                               mass_balance=mass_balance)
   ....: 

In [15]: collection = GlacierCollection()

In [16]: collection.add([glacier, wide_narrow_glacier])

In [17]: collection.progress_to_year(600)

In [18]: collection.plot()
_images/plot_glacier_collection.png