docs: add missing configuration options
This commit is contained in:
parent
12d38bd867
commit
2586969995
3
doc/configtables/conventional.csv
Normal file
3
doc/configtables/conventional.csv
Normal file
@ -0,0 +1,3 @@
|
||||
,Unit,Values,Description
|
||||
{name},--,"string","For any carrier/technology overwrite attributes as listed below."
|
||||
-- {attribute},--,"string or float","For any attribute, can specify a float or reference to a file path to a CSV file giving floats for each country (2-letter code)."
|
|
5
doc/configtables/run.csv
Normal file
5
doc/configtables/run.csv
Normal file
@ -0,0 +1,5 @@
|
||||
,Unit,Values,Description
|
||||
name,--,"any string","Specify a name for your run. Results will be stored under this name."
|
||||
disable_progrssbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."
|
||||
shared_resources,bool,"{true, false}","Switch to select whether resources should be shared across runs."
|
||||
shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."
|
|
@ -4,11 +4,6 @@ tutorial,bool,"{true, false}","Switch to retrieve the tutorial data set instead
|
||||
logging,,,
|
||||
-- level,--,"Any of {'INFO', 'WARNING', 'ERROR'}","Restrict console outputs to all infos, warning or errors only"
|
||||
-- format,--,"","Custom format for log messages. See `LogRecord <https://docs.python.org/3/library/logging.html#logging.LogRecord>`_ attributes."
|
||||
run,,,
|
||||
-- name,--,"any string","Specify a name for your run. Results will be stored under this name."
|
||||
-- disable_progrssbar,bool,"{true, false}","Switch to select whether progressbar should be disabled."
|
||||
-- shared_resources,bool,"{true, false}","Switch to select whether resources should be shared across runs."
|
||||
-- shared_cutouts,bool,"{true, false}","Switch to select whether cutouts should be shared across runs."
|
||||
foresight,string,"{overnight, myopic, perfect}","Defaults to overnight scenarios."
|
||||
countries,--,"Subset of {'AL', 'AT', 'BA', 'BE', 'BG', 'CH', 'CZ', 'DE', 'DK', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'ME', 'MK', 'NL', 'NO', 'PL', 'PT', 'RO', 'RS', 'SE', 'SI', 'SK'}","European countries defined by their `Two-letter country codes (ISO 3166-1) <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`_ which should be included in the energy system model."
|
||||
focus_weights,--,"Keys should be two-digit country codes (e.g. DE) and values should range between 0 and 1","Ratio of total clusters for particular countries. the remaining weight is distributed according to mean load. An example: ``focus_weights: 'DE': 0.6 'FR': 0.2``."
|
||||
|
|
@ -42,6 +42,10 @@ The ``run`` section is used for running and storing scenarios with different con
|
||||
:start-at: run:
|
||||
:end-before: foresight:
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:widths: 25,7,22,30
|
||||
:file: configtables/run.csv
|
||||
|
||||
``scenario``
|
||||
============
|
||||
@ -111,6 +115,11 @@ Switches for some rules and optional features.
|
||||
:start-at: enable:
|
||||
:end-before: co2_budget:
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:widths: 25,7,22,30
|
||||
:file: configtables/enable.csv
|
||||
|
||||
.. _electricity_cf:
|
||||
|
||||
``electricity``
|
||||
@ -230,6 +239,10 @@ overwrite the existing values.
|
||||
:start-at: conventional:
|
||||
:end-before: lines:
|
||||
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:widths: 25,7,22,30
|
||||
:file: configtables/conventional.csv
|
||||
|
||||
``lines``
|
||||
=============
|
||||
@ -436,7 +449,7 @@ overwrite the existing values.
|
||||
.. csv-table::
|
||||
:header-rows: 1
|
||||
:widths: 25,7,22,30
|
||||
:file: configtables/solving-solver.csv
|
||||
:file: configtables/solving.csv
|
||||
|
||||
.. _plotting_cf:
|
||||
|
||||
|
@ -9,9 +9,11 @@ pypsa
|
||||
vresutils>=0.3.1
|
||||
powerplantmatching>=0.5.5
|
||||
atlite>=0.2.9
|
||||
dask
|
||||
dask[distributed]
|
||||
matplotlib
|
||||
tabula-py
|
||||
|
||||
# cartopy
|
||||
cartopy
|
||||
scikit-learn
|
||||
pycountry
|
||||
pyyaml
|
||||
|
@ -305,6 +305,7 @@ configuration file.
|
||||
commit to a run:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
snakemake -call solve_elec_networks -n
|
||||
|
||||
How to analyse results?
|
||||
|
Loading…
Reference in New Issue
Block a user