openscm_runner.run

Contents

openscm_runner.run#

High-level run function

run#

run(climate_models_cfgs, scenarios, output_variables=('Surface Temperature',), out_config=None)[source]#

Run a number of climate models over a number of scenarios

Parameters:
  • climate_models_cfgs (dict[str: list]) – Dictionary where each key is a model and each value is the configs with which to run the model. The configs are passed to the model adapter.

  • scenarios (pyam.IamDataFrame) – Scenarios to run

  • output_variables (list[str]) – Variables to include in the output

  • out_config (dict[str: tuple of str]) – Dictionary where each key is a model and each value is a tuple of configuration values to include in the output’s metadata.

Returns:

scmdata.ScmRun – Model output

Raises:
  • KeyErrorout_config has keys which are not in climate_models_cfgs

  • TypeError – A value in out_config is not a tuple