scenario management: use "shared_cutouts" instead of "dedicated_cutouts"

Snakefile

@@ -15,7 +15,7 @@ configfile: "config.yaml"
 
 run = config.get("run", {})
 RDIR = run["name"] + "/" if run.get("name") else ""
-CDIR = RDIR if run.get("dedicated_cutouts", True) else ""
+CDIR = RDIR if not run.get("shared_cutouts") else "" 
 
 COSTS = "resources/" + RDIR + "costs.csv"
 ATLITE_NPROCESSES = config['atlite'].get('nprocesses', 4)

config.default.yaml

@@ -11,7 +11,7 @@ logging:
 
 run: 
   name: "" # use this to keep track of runs with different settings
-  dedicated_cutouts: True # set to false to use the default cutout(s)
+  shared_cutouts: false # set to true to share the default cutout(s) across runs
 
 
 scenario:

doc/configuration.rst

@@ -35,7 +35,7 @@ It is common conduct to analyse energy system optimisation models for **multiple
 e.g. assessing their sensitivity towards changing the temporal and/or geographical resolution or investigating how
 investment changes as more ambitious greenhouse-gas emission reduction targets are applied.
 
-The ``run`` section is used for running and storing scenarios with different configurations which are not covered by :ref:`wildcards`. It determines the path at which resources, networks and results are stored. Therefore the user can run different configurations within the same directory. If a run with a non-empty name should use cutouts shared across runs, set ``shared_cutouts`` to `true`.       
+The ``run`` section is used for running and storing scenarios with different configurations which are not covered by :ref:`wildcards`. It determines the path at which resources, networks and results are stored. Therefore the user can run different configurations within the same directory. If a run with a non-empty name should use cutouts shared across runs, set ``shared_cutouts`` to `true`.    
 
 .. literalinclude:: ../config.default.yaml
    :language: yaml

doc/release_notes.rst

@@ -34,7 +34,7 @@ PyPSA-Eur 0.6.0 (10th September 2022)
   setting ``excluder_resolution``.
 
 
-* The software now supports running the workflow with different settings within the same directory. A new config section ``run`` was created that specifies under which scenario ``name`` the created resources, networks and results should be stored. If ``name`` is not specified, the workflow uses the default paths. The entry ``dedicated_cutouts`` specifies whether the run should use cutouts from the default root directory and use run-specific cutouts.
+* The software now supports running the workflow with different settings within the same directory. A new config section ``run`` was created that specifies under which scenario ``name`` the created resources, networks and results should be stored. If ``name`` is not specified, the workflow uses the default paths. The entry ``shared_cutouts`` specifies whether the run should use cutouts from the default root directory or use run-specific cutouts.
 
 PyPSA-Eur 0.5.0 (27th July 2022)
 =====================================