oggm.GlacierDirectory

class oggm.GlacierDirectory(rgi_entity, base_dir=None, reset=False, from_tar=False, delete_tar=False)[source]

Organizes read and write access to the glacier’s files.

It handles a glacier directory created in a base directory (default is the “per_glacier” folder in the working directory). The role of a GlacierDirectory is to give access to file paths and to I/O operations. The user should not care about where the files are located, but should know their name (see cfg.BASENAMES).

If the directory does not exist, it will be created.

See Glacier directories for more information.

Attributes:
dir : str

path to the directory

rgi_id : str

The glacier’s RGI identifier

glims_id : str

The glacier’s GLIMS identifier (when available)

rgi_area_km2 : float

The glacier’s RGI area (km2).

cenlon, cenlat : float

The glacier centerpoint’s lon/lat

rgi_date : int

The RGI’s BGNDATE year attribute if available. Otherwise, defaults to the median year for the RGI region

rgi_region : str

The RGI region name

name : str

The RGI glacier name (if Available)

glacier_type : str

The RGI glacier type (‘Glacier’, ‘Ice cap’, ‘Perennial snowfield’, ‘Seasonal snowfield’)

terminus_type : str

The RGI terminus type (‘Land-terminating’, ‘Marine-terminating’, ‘Lake-terminating’, ‘Dry calving’, ‘Regenerated’, ‘Shelf-terminating’)

is_tidewater : bool

Is the glacier a caving glacier?

inversion_calving_rate : float

Calving rate used for the inversion

__init__(self, rgi_entity, base_dir=None, reset=False, from_tar=False, delete_tar=False)[source]

Creates a new directory or opens an existing one.

Parameters:
rgi_entity : a geopandas.GeoSeries or str

glacier entity read from the shapefile (or a valid RGI ID if the directory exists)

base_dir : str

path to the directory where to open the directory. Defaults to cfg.PATHS[‘working_dir’] + /per_glacier/

reset : bool, default=False

empties the directory at construction (careful!)

from_tar : str or bool, default=False

path to a tar file to extract the gdir data from. If set to True, will check for a tar file at the expected location in base_dir.

delete_tar : bool, default=False

delete the original tar file after extraction.

Methods

__init__(self, rgi_entity[, base_dir, …]) Creates a new directory or opens an existing one.
add_to_diagnostics(self, key, value) Write a key, value pair to the gdir’s runtime diagnostics.
get_diagnostics(self) Read the gdir’s runtime diagnostics.
get_error_log(self) Reads the directory’s log file to find the invalid task (if any).
get_filepath(self, filename[, delete, …]) Absolute path to a specific file.
get_inversion_flowline_hw(self) Shortcut function to read the heights and widths of the glacier.
get_ref_length_data(self) Get the glacier length data from P.
get_ref_mb_data(self) Get the reference mb data from WGMS (for some glaciers only!).
get_ref_mb_profile(self) Get the reference mb profile data from WGMS (if available!).
get_task_status(self, task_name) Opens this directory’s log file to see if a task was already run.
has_file(self, filename) Checks if a file exists.
log(self, task_name[, err]) Logs a message to the glacier directory.
read_json(self, filename[, filesuffix]) Reads a JSON file located in the directory.
read_pickle(self, filename[, …]) Reads a pickle located in the directory.
read_shapefile(self, filename[, filesuffix]) Reads a shapefile located in the directory.
read_text(self, filename[, filesuffix]) Reads a text file located in the directory.
set_ref_mb_data(self[, mb_df]) Adds reference mass-balance data to this glacier.
write_json(self, var, filename[, filesuffix]) Writes a variable to a pickle on disk.
write_monthly_climate_file(self, time, prcp, …) Creates a netCDF4 file with climate data timeseries.
write_pickle(self, var, filename[, …]) Writes a variable to a pickle on disk.
write_shapefile(self, var, filename[, …]) Writes a variable to a shapefile on disk.

Attributes

dem_daterange Years in which most of the DEM data was acquired
dem_info More detailed information on the acquisition of the DEM data
grid A salem.Grid handling the georeferencing of the local grid
rgi_area_km2 The glacier’s RGI area (km2).
rgi_area_m2 The glacier’s RGI area (m2).