@@ -22,25 +22,25 @@ The configuration of an Open-TYNDP run is set from several files. The list below
2222hierarchy in which they are applied, from the base defaults up to the most specific overrides,
2323with each layer overriding the ones listed before it:
2424
25- - ** ` config/config.default.yaml ` ** — the base defaults, auto-generated from the configuration
26- schema and inherited from PyPSA-Eur. Together with ` config/plotting. default.yaml ` and
27- ` config/benchmarking.default.yaml ` , it covers every option that can be set and provides a
28- value for each. These files are maintained in the repository and should not be edited
29- directly.
30- - ** ` config/data.tyndp.yaml ` ** — an optional data-source layer, loaded on top of the defaults
25+ - ** ` config/config.default.yaml ` ** : The base defaults, auto-generated from the configuration
26+ schema, inherited from PyPSA-Eur and extended by new default open-tyndp configuration options.
27+ Together with ` config/plotting.default.yaml ` and ` config/ benchmarking.default.yaml` , it covers
28+ every option that can be set and provides a value for each. These files are maintained in the
29+ repository and should not be edited directly.
30+ - ** ` config/data.tyndp.yaml ` ** : An optional data-source layer, loaded on top of the defaults
3131 when [ ` data_config: tyndp ` ] ( #data_config_cf ) is set. It switches the supported datasets to the
3232 Open-TYNDP archive mirror on Google Cloud Storage (see [ Data Sources] ( sb.md#tyndp_archive ) ).
33- - ** ` config/config.yaml ` ** — your own local overrides. This file is not part of the repository
33+ - ** ` config/config.yaml ` ** : A user's local overrides. This file is not part of the repository
3434 and is not tracked by git, but Snakemake always picks it up if it exists, which makes it a
35- convenient place to keep machine-specific settings without touching the tracked files. You
36- can use ` config/config.private.template.yaml ` as a starting point.
37- - ** ` config/config.tyndp.yaml ` ** — the Open-TYNDP run-level configuration. This is the file
35+ convenient place to keep machine-specific settings without touching the tracked files.
36+ ` config/config.private.template.yaml ` can be used as a starting point.
37+ - ** ` config/config.tyndp.yaml ` ** : The Open-TYNDP run-level configuration. This is the file
3838 passed to Snakemake by the ` pixi run tyndp-sb ` and ` pixi run tyndp-cba ` entry points via
39- ` --configfile ` , so it overrides all of the layers above. It activates the TYNDP-specific
40- rules (through [ ` tyndp_scenario ` ] ( #tyndp_scenario_cf ) ) and sets the model-wide choices shared
41- across scenarios, such as the modelled countries, snapshots, foresight mode, and planning
42- horizons.
43- - ** ` config/scenarios.tyndp.yaml ` ** — the per-scenario overrides, applied on top of the
39+ ` --configfile ` , so it overrides all of the layers above for the specified configuration options.
40+ It activates the TYNDP-specific rules (through [ ` tyndp_scenario ` ] ( #tyndp_scenario_cf ) ) and sets the model-wide
41+ choices shared across scenarios, such as the modelled countries, snapshots, foresight mode,
42+ and planning horizons.
43+ - ** ` config/scenarios.tyndp.yaml ` ** : The per-scenario overrides, applied on top of the
4444 run-level configuration. ` config.tyndp.yaml ` points to this file through ` run.scenarios.file `
4545 and switches it on with ` run.scenarios.enable: true ` . Each named scenario (e.g. ` NT ` , ` DE ` ,
4646 ` GA ` , or a climate-year collection) supplies only the settings that differ from the run-level
@@ -49,12 +49,12 @@ with each layer overriding the ones listed before it:
4949 [ Cost-Benefit Analysis] ( cba.md#running-single-vs-multiple-climate-years ) for how each
5050 workflow uses these scenarios.
5151
52- Any option you set in a higher layer overrides the value from the layers below it, while
53- options you leave unset are inherited from the defaults. To try out a change you therefore only
54- need to specify the handful of options that differ — everything else falls back to
52+ Any option a user sets in a higher layer overrides the value from the layers below it, while
53+ options that are left unset are inherited from the defaults. To try out a change a user therefore only
54+ need to specify the handful of options that differ while everything else falls back to
5555` config.tyndp.yaml ` and the defaults.
5656
57- Beyond these files, you are free to add configuration files of your own, e.g. ` my_config.yaml ` ,
57+ Beyond these files, users are free to add configuration files of their own, e.g. ` my_config.yaml ` ,
5858and pass them explicitly to Snakemake:
5959
6060``` console
@@ -83,10 +83,10 @@ with `--configfile`, it takes precedence over `config/config.yaml`; to override
8383
8484## ` version ` {#version_cf}
8585
86- Version of PyPSA-Eur . Descriptive only.
86+ Version of Open-TYNDP . Descriptive only.
8787
8888- ** Type:** string
89- - ** Default:** ` v2026.02.0 `
89+ - ** Default:** ` v0.7.1 `
9090
9191** YAML Syntax**
9292
@@ -145,7 +145,7 @@ investment changes as more ambitious greenhouse-gas emission reduction targets a
145145
146146The ` run ` section is used for running and storing scenarios with different configurations which are not covered by [ wildcards] ( #wildcards ) .
147147It determines the path at which resources, networks and results are stored.
148- Therefore the user can run different configurations within the same directory.
148+ Therefore, the user can run different configurations within the same directory.
149149
150150Configuration for top level ` run ` settings.
151151
0 commit comments