def save_commented_model_yaml(self, path):
"""
Save a fully built and commented version of the model to a YAML file
at the given ``path``. Comments in the file indicate where values
were overridden. This is Calliope's internal representation of
a model directly before the model_data xarray.Dataset is built,
and can be useful for debugging possible issues in the model
formulation.
"""
if not self._model_run or not self._debug_data:
raise KeyError(
'This model does not have the fully built model attached, '
'so `save_commented_model_yaml` is not available. Likely '
'reason is that the model was built with a verion of Calliope '
'prior to 0.6.5.'
)
yaml = ruamel_yaml.YAML()
model_run_debug = self._model_run.copy()
try:
del model_run_debug['timeseries_data'] # Can't be serialised!
except KeyError:
# Possible that timeseries_data is already gone if the model
# was read from a NetCDF file
pass
# Turn sets in model_run into lists for YAML serialization
for k, v in model_run_debug.sets.items():
model_run_debug.sets[k] = list(v)
debug_comments = self._debug_data['comments']
stream = StringIO()
yaml.dump(model_run_debug.as_dict(), stream=stream)
debug_yaml = yaml.load(stream.getvalue())
for k in debug_comments.model_run.keys_nested():
v = debug_comments.model_run.get_key(k)
if v:
keys = k.split('.')
apply_to_dict(debug_yaml, keys[:-1], 'yaml_add_eol_comment', (v, keys[-1]))
dumper = ruamel_yaml.dumper.RoundTripDumper
dumper.ignore_aliases = lambda self, data: True
with open(path, 'w') as f:
ruamel_yaml.dump(
debug_yaml,
stream=f,
Dumper=dumper,
default_flow_style=False
)
def save_commented_model_yaml(self, path):
"""
Save a fully built and commented version of the model to a YAML file
at the given ``path``. Comments in the file indicate where values
were overridden. This is Calliope's internal representation of
a model directly before the model_data xarray.Dataset is built,
and can be useful for debugging possible issues in the model
formulation.
"""
yaml = ruamel_yaml.YAML()
model_run_debug = self._model_run.copy()
del model_run_debug['timeseries_data'] # Can't be serialised!
# Turn sets in model_run into lists for YAML serialization
for k, v in model_run_debug.sets.items():
model_run_debug.sets[k] = list(v)
debug_comments = self._debug_data['comments']
stream = StringIO()
yaml.dump(model_run_debug.as_dict(), stream=stream)
debug_yaml = yaml.load(stream.getvalue())
for k in debug_comments.model_run.keys_nested():
v = debug_comments.model_run.get_key(k)
if v:
keys = k.split('.')
apply_to_dict(debug_yaml, keys[:-1], 'yaml_add_eol_comment', (v, keys[-1]))
dumper = ruamel_yaml.dumper.RoundTripDumper
dumper.ignore_aliases = lambda self, data: True
with open(path, 'w') as f:
ruamel_yaml.dump(
debug_yaml,
stream=f,
Dumper=dumper,
default_flow_style=False
)
def save_commented_model_yaml(self, path):
"""
Save a fully built and commented version of the model to a YAML file
at the given ``path``. Comments in the file indicate where values
were overridden. This is Calliope's internal representation of
a model directly before the model_data xarray.Dataset is built,
and can be useful for debugging possible issues in the model
formulation.
"""
yaml = ruamel_yaml.YAML()
model_run_debug = self._model_run.copy()
del model_run_debug['timeseries_data'] # Can't be serialised!
# Turn sets in model_run into lists for YAML serialization
for k, v in model_run_debug.sets.items():
model_run_debug.sets[k] = list(v)
debug_comments = self._debug_data['comments']
stream = StringIO()
yaml.dump(model_run_debug.as_dict(), stream=stream)
debug_yaml = yaml.load(stream.getvalue())
for k in debug_comments.model_run.keys_nested():
v = debug_comments.model_run.get_key(k)
if v:
keys = k.split('.')
apply_to_dict(debug_yaml, keys[:-1], 'yaml_add_eol_comment',
(v, keys[-1]))
dumper = ruamel_yaml.dumper.RoundTripDumper
dumper.ignore_aliases = lambda self, data: True
with open(path, 'w') as f:
ruamel_yaml.dump(debug_yaml,
stream=f,
Dumper=dumper,
default_flow_style=False)