pypsa-eur/doc/configtables/run.csv

,Unit,Values,Description
name,--,str/list,"Specify a name for your run. Results will be stored under this name. If ``scenario: enable:`` is set to ``true``, the name must contain a subset of scenario names defined in ``scenario: file:``. If the name is 'all', all defined scenarios will be run."
prefix,--,str,"Prefix for the run name which is used as a top-layer directory name in the results and resources folders."
scenarios,,,
-- enable,bool,"{true, false}","Switch to select whether workflow should generate scenarios based on ``file``."
-- file,str,,"Path to the scenario yaml file. The scenario file contains config overrides for each scenario. In order to be taken account, ``run: scenarios`` has to be set to ``true`` and ``run: name`` has to be a subset of top level keys given in the scenario file. In order to automatically create a `scenario.yaml` file based on a combination of settings, alter and use the ``config/create_scenarios.py`` script in the ``config`` directory."
disable_progressbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."
shared_resources,,,
-- policy,bool/str,,"Boolean switch to select whether resources should be shared across runs. If a string is passed, this is used as a subdirectory name for shared resources. If set to 'base', only resources before creating the elec.nc file are shared."
-- exclude,str,"For the case shared_resources=base, specify additional files that should not be shared across runs."
shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."
docs: add missing configuration options 2023-03-16 11:05:36 +00:00			`,Unit,Values,Description`
run: name: all will collect all keys from scenarios.yaml if run: scenarios: enable: true 2024-02-18 09:24:26 +00:00			name,--,str/list,"Specify a name for your run. Results will be stored under this name. If ``scenario: enable:`` is set to ``true``, the name must contain a subset of scenario names defined in ``scenario: file:``. If the name is 'all', all defined scenarios will be run."
add doc and release notes 2024-04-10 14:56:35 +00:00			`prefix,--,str,"Prefix for the run name which is used as a top-layer directory name in the results and resources folders."`
scenario-management: use list for including wildcards with shared resource 2023-08-24 11:17:44 +00:00			`scenarios,,,`
scenario-management: reenable shared resources, make shared resources wildcards dependent 2023-08-23 15:14:57 +00:00			-- enable,bool,"{true, false}","Switch to select whether workflow should generate scenarios based on ``file``."
handle complicated config-dependent inputs using unpack() with input functions 2024-02-12 15:56:00 +00:00			-- file,str,,"Path to the scenario yaml file. The scenario file contains config overrides for each scenario. In order to be taken account, ``run: scenarios`` has to be set to ``true`` and ``run: name`` has to be a subset of top level keys given in the scenario file. In order to automatically create a `scenario.yaml` file based on a combination of settings, alter and use the ``config/create_scenarios.py`` script in the ``config`` directory."
run: name: all will collect all keys from scenarios.yaml if run: scenarios: enable: true 2024-02-18 09:24:26 +00:00			`disable_progressbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."`
rearrange config settings under 'run: shared_resources:' 2024-05-13 12:08:38 +00:00			`shared_resources,,,`
			`-- policy,bool/str,,"Boolean switch to select whether resources should be shared across runs. If a string is passed, this is used as a subdirectory name for shared resources. If set to 'base', only resources before creating the elec.nc file are shared."`
			`-- exclude,str,"For the case shared_resources=base, specify additional files that should not be shared across runs."`
docs: add missing configuration options 2023-03-16 11:05:36 +00:00			`shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."`