Skip to content

add default values to settings #1833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pat-schmitt wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

add default values to settings #1833

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions oggm/utils/_workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2732,7 +2732,8 @@ class GlacierDirectory(object):

def __init__(self, rgi_entity, base_dir=None, reset=False,
from_tar=False, delete_tar=False, settings_filesuffix='',
observations_filesuffix=''):
observations_filesuffix='',
add_default_values_to_settings=True):
"""Creates a new directory or opens an existing one.

Parameters
Expand All @@ -2754,6 +2755,9 @@ def __init__(self, rgi_entity, base_dir=None, reset=False,
a filesuffix for a settings file to use
observations_filesuffix : str, default=''
a filesuffix for a observations file to use
add_default_values_to_settings : bool, default=True
if True and a settings value is read from the default settings file
this value is also added to the current settings file
"""

if base_dir is None:
Expand Down Expand Up @@ -2832,6 +2836,7 @@ def __init__(self, rgi_entity, base_dir=None, reset=False,
raise RuntimeError('GlacierDirectory %s does not exist!' % self.dir)

# define the initial settings for this gdir
self.add_default_values_to_settings = add_default_values_to_settings
self._settings_filesuffix = settings_filesuffix
self.settings = self.get_settings(settings_filesuffix=settings_filesuffix)

Expand Down Expand Up @@ -4073,8 +4078,9 @@ def settings_filesuffix(self, value):
self.settings = self.get_settings(settings_filesuffix=value)

def get_settings(self, settings_filesuffix):
return ModelSettings(self, filesuffix=settings_filesuffix,
always_reload_data=False)
return ModelSettings(
self, filesuffix=settings_filesuffix, always_reload_data=False,
add_default_values=self.add_default_values_to_settings)

@property
def observations_filesuffix(self):
Expand Down Expand Up @@ -4432,7 +4438,7 @@ def __contains__(self, key):
class ModelSettings(YAMLFileObject):
def __init__(self, gdir, filesuffix='', parent_filesuffix=None,
reset_parent_filesuffix=False, allow_empty=True,
always_reload_data=True,
always_reload_data=True, add_default_values=True,
):
path = gdir.get_filepath('settings', filesuffix=filesuffix)

Expand Down Expand Up @@ -4468,8 +4474,10 @@ def __init__(self, gdir, filesuffix='', parent_filesuffix=None,
# check if parent exists
allow_empty=False,
always_reload_data=always_reload_data,
add_default_values=add_default_values,
)
self.gdir = gdir
self.add_default_values = add_default_values

def get(self, key):
if self.always_reload_data:
Expand All @@ -4483,7 +4491,8 @@ def get(self, key):
# this is for backwards compatibility when mb_calib files was used
try:
value = self.gdir.read_json('mb_calib')[key]
self.set(key, value)
if self.add_default_values:
self.set(key, value)
return value
except FileNotFoundError:
pass
Expand All @@ -4494,15 +4503,17 @@ def get(self, key):
# stored in the diagnostics
try:
value = self.gdir.get_diagnostics()[key]
self.set(key, value)
if self.add_default_values:
self.set(key, value)
return value
except KeyError:
pass

try:
# if a key is used from defaults, also add it to the settings file
value = self.defaults[key]
self.set(key, value)
if self.add_default_values:
self.set(key, value)
return value
except KeyError:
raise KeyError(f"Key '{key}' not found!")
Expand Down