Merge pull request #1011 from PyPSA/add_prefix_scenario_management

Add prefix scenario management

config/config.default.yaml

@@ -20,6 +20,7 @@ remote:
 
 # docs in https://pypsa-eur.readthedocs.io/en/latest/configuration.html#run
 run:
+  prefix: ""
   name: ""
   scenarios:
     enable: false

doc/configtables/run.csv

@@ -1,5 +1,6 @@
 ,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."

doc/release_notes.rst

@@ -152,6 +152,9 @@ Upcoming Release
   - Collection rules get a new wildcard ``run=config["run"]["name"]`` so they
     can collect outputs across different scenarios.
 
+  - It is further possible to encapsulate your scenarios in a directory using
+    the setting ``run: prefix:``.
+
   - **Warning:** One caveat remains for the scenario management with myopic or
     perfect foresight pathway optimisation. The first investment period must be
     shared across all scenarios. The reason is that the ``wildcard_constraints``

scripts/_helpers.py

@@ -59,6 +59,11 @@ def get_rdir(run):
         RDIR = run["name"] + "/"
     else:
         RDIR = ""
+
+    prefix = run.get("prefix", "")
+    if prefix:
+        RDIR = f"{prefix}/{RDIR}"
+
     return RDIR