oggm.workflow.init_glacier_directories

oggm.workflow.init_glacier_directories(rgidf=None, *, reset=False, force=False, from_prepro_level=None, prepro_border=None, prepro_rgi_version=None, prepro_base_url=None, from_tar=False, delete_tar=False)

Initializes the list of Glacier Directories for this run.

This is the very first task to do (always). If the directories are already available in the working directory, use them. If not, create new ones.

Careful: when starting from a pre-processed directory with from_prepro_level or from_tar, the existing directories will be overwritten!

Parameters

rgidfGeoDataFrame or list of ids, optional for pre-computed runs

the RGI glacier outlines. If unavailable, OGGM will parse the information from the glacier directories found in the working directory. It is required for new runs.

resetbool

delete the existing glacier directories if found.

forcebool

setting reset=True will trigger a yes/no question to the user. Set force=True to avoid this.

from_prepro_levelint

get the gdir data from the official pre-processed pool. If this argument is set, the existing directories will be overwritten!

prepro_borderint

for from_prepro_level only: if you want to override the default behavior which is to use cfg.PARAMS[‘border’]

prepro_rgi_versionstr

for from_prepro_level only: if you want to override the default behavior which is to use cfg.PARAMS[‘rgi_version’]

prepro_base_urlstr

for from_prepro_level only: the preprocessed directory url from which to download the directories (became mandatory in OGGM v1.6)

from_tarbool or str, default=False

extract the gdir data from a tar file. If set to True, will check for a tar file at the expected location in base_dir. delete the original tar file after extraction. If this argument is set, the existing directories will be overwritten!

Returns

gdirslist of oggm.GlacierDirectory objects

the initialised glacier directories