diff --git a/doc/configtables/costs.csv b/doc/configtables/costs.csv index 16339488..5cd54029 100644 --- a/doc/configtables/costs.csv +++ b/doc/configtables/costs.csv @@ -1,7 +1,7 @@ ,Unit,Values,Description -year,--,{'E'},TODO -discountrate,--,E,TODO -USD2013_to_EUR2013,--,E,TODO -capital_cost,--,E,TODO -marginal_cost,--,E,TODO +year,--,"YYYY; e.g. '2030'","Year for which to retrieve cost assumptions of ``data/costs.csv``." +discountrate,--,float,"Default discount rate if not specified for a technology in ``data/costs.csv``." +USD2013_to_EUR2013,--,float,"Exchange rate from USD :math:`_{2013}` to EUR :math:`_{2013}` from `ECB `_" +capital_cost,EUR/MW,"Keys should be in the 'technology' column of ``data/costs.csv``. Values can be any float.","For the given technologies, assumptions about their capital investment costs are set to the corresponding value. Optional; overwrites cost assumptions from ``data/costs.csv``." +marginal_cost,EUR/MWh,"Keys should be in the 'technology' column of ``data/costs.csv``. Values can be any float.","For the given technologies, assumptions about their marginal operating costs are set to the corresponding value. Optional; overwrites cost assumptions from ``data/costs.csv``." emission_prices,--,E,TODO \ No newline at end of file diff --git a/doc/configtables/hydro.csv b/doc/configtables/hydro.csv index f1c32bd9..45eb0886 100644 --- a/doc/configtables/hydro.csv +++ b/doc/configtables/hydro.csv @@ -1,6 +1,6 @@ ,Unit,Values,Description -cutout,--,{'E'},TODO -carriers,--,E,TODO -PHS_max_hours,--,E,TODO -hydro_max_hours,--,E,TODO -clip_min_inflow,--,E,TODO \ No newline at end of file +cutout,--,"Must be 'europe-2013-era5'","Specifies the directory where the relevant weather data ist stored." +carriers,--,"Any subset of {'ror', 'PHS', 'hydro'}","Specifies the types of hydro power plants to build per-unit availability time series for. 'ror' stands for run-of-river plants, 'PHS' represents pumped-hydro storage, and 'hydro' stands for hydroelectric dams." +PHS_max_hours,h,float,"Maximum state of charge capacity of the pumped-hydro storage (PHS) in terms of hours at full output capacity ``p_nom``. Cf. `PyPSA documentation `_." +hydro_max_hours,h,"Any of {float, 'energy_capacity_totals_by_country', 'estimate_by_large_installations'}","Maximum state of charge capacity of the pumped-hydro storage (PHS) in terms of hours at full output capacity ``p_nom`` or heuristically determined. Cf. `PyPSA documentation `_." +clip_min_inflow,??,float,"To avoid too small values in the inflow time series, values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/lines.csv b/doc/configtables/lines.csv index 3ef081d2..e5067867 100644 --- a/doc/configtables/lines.csv +++ b/doc/configtables/lines.csv @@ -1,9 +1,5 @@ ,Unit,Values,Description -types,--,{'E'},TODO --- 220.,--,E,TODO --- 300.,--,E,TODO --- 380.,--,E,TODO -s_max_pu,--,E,TODO -length_factor,--,E,TODO -length_factor,--,E,TODO -under_construction,--,E,TODO \ No newline at end of file +types,--,"Values should specify a `line type in PyPSA `_. Keys should specify the corresponding voltage level (e.g. 220., 300. and 380. kV)","Specifies line types to assume for the different voltage levels of the ENTSO-E grid extraction. Should normally handle voltage levels 220, 300, and 380 kV" +s_max_pu,--,"Value in [0.,1.]","Correction factor for line capacities (``s_nom``) to approximate :math:`N-1` security and reserve capacity for reactive power flows" +length_factor,--,float,"Correction factor to account for the fact that buses are *not* connected by lines through air-line distance." +under_construction,--,"One of {'zero': set capacity to zero, 'remove': remove completely, 'keep': keep with full capacity}","Specifies how to handle lines which are currently under construction." \ No newline at end of file diff --git a/doc/configtables/links.csv b/doc/configtables/links.csv index 83aec747..d77c9ddd 100644 --- a/doc/configtables/links.csv +++ b/doc/configtables/links.csv @@ -1,4 +1,4 @@ ,Unit,Values,Description -p_max_pu,--,{'E'},TODO -include_tyndp,--,E,TODO -under_construction,--,E,TODO \ No newline at end of file +p_max_pu,--,"Value in [0.,1.]","Correction factor for link capacities ``p_nom``." +include_tyndp,bool,"{'true', 'false'}","Specifies whether to add HVDC link projects from the `TYNDP 2018 `_ which are at least in permitting." +under_construction,--,"One of {'zero': set capacity to zero, 'remove': remove completely, 'keep': keep with full capacity}","Specifies how to handle lines which are currently under construction." \ No newline at end of file diff --git a/doc/configtables/load.csv b/doc/configtables/load.csv index 0a0cd829..035b27a1 100644 --- a/doc/configtables/load.csv +++ b/doc/configtables/load.csv @@ -1,2 +1,2 @@ ,Unit,Values,Description -scaling_factor,--,{'E'},TODO \ No newline at end of file +scaling_factor,--,float,"Global correction factor for the load time series." \ No newline at end of file diff --git a/doc/configtables/offwind-ac.csv b/doc/configtables/offwind-ac.csv index 088c18f2..f9eba18e 100644 --- a/doc/configtables/offwind-ac.csv +++ b/doc/configtables/offwind-ac.csv @@ -1,12 +1,12 @@ ,Unit,Values,Description -cutout,--,{'E'},TODO -resource,--,E,TODO --- method,--,E,TODO --- turbine,--,E,TODO -capacity_per_sqkm,--,E,TODO -corine,--,E,TODO -natura,--,E,TODO -max_depth,--,E,TODO -min_shore_distance,--,E,TODO -potential,--,E,TODO -clip_p_max_pu,--,E,TODO \ No newline at end of file +cutout,--,"Must be 'europe-2013-era5'","Specifies the directory where the relevant weather data ist stored." +resource,,, +-- method,--,"Must be 'wind'","A superordinate technology type." +-- turbine,--,"One of turbine types included in `atlite `_","Specifies the turbine type and its characteristic power curve." +capacity_per_sqkm,:math:`MW/km^2`,float,"Allowable density of wind turbine placement." +corine,--,"Any *realistic* subset of the `CORINE Land Cover code list `_","Specifies areas according to CORINE Land Cover codes which are generally eligible for AC-connected offshore wind turbine placement." +natura,bool,"{true, false}","Switch to exclude `Natura 2000 `_ natural protection areas. Area is excluded if ``true``." +max_depth,m,float,"Maximum sea water depth at which wind turbines can be build. Maritime areas with deeper waters are excluded in the process of calculating the AC-connected offshore wind potential." +min_shore_distance,m,float,"Minimum distance to the shore below which wind turbines cannot be build. Such areas close to the shore are excluded in the process of calculating the AC-connected offshore wind potential." +potential,--,"One of {'simple', 'conservative'}",TODO +clip_p_max_pu,p.u.,float,"To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/offwind-dc.csv b/doc/configtables/offwind-dc.csv index 088c18f2..f9eba18e 100644 --- a/doc/configtables/offwind-dc.csv +++ b/doc/configtables/offwind-dc.csv @@ -1,12 +1,12 @@ ,Unit,Values,Description -cutout,--,{'E'},TODO -resource,--,E,TODO --- method,--,E,TODO --- turbine,--,E,TODO -capacity_per_sqkm,--,E,TODO -corine,--,E,TODO -natura,--,E,TODO -max_depth,--,E,TODO -min_shore_distance,--,E,TODO -potential,--,E,TODO -clip_p_max_pu,--,E,TODO \ No newline at end of file +cutout,--,"Must be 'europe-2013-era5'","Specifies the directory where the relevant weather data ist stored." +resource,,, +-- method,--,"Must be 'wind'","A superordinate technology type." +-- turbine,--,"One of turbine types included in `atlite `_","Specifies the turbine type and its characteristic power curve." +capacity_per_sqkm,:math:`MW/km^2`,float,"Allowable density of wind turbine placement." +corine,--,"Any *realistic* subset of the `CORINE Land Cover code list `_","Specifies areas according to CORINE Land Cover codes which are generally eligible for AC-connected offshore wind turbine placement." +natura,bool,"{true, false}","Switch to exclude `Natura 2000 `_ natural protection areas. Area is excluded if ``true``." +max_depth,m,float,"Maximum sea water depth at which wind turbines can be build. Maritime areas with deeper waters are excluded in the process of calculating the AC-connected offshore wind potential." +min_shore_distance,m,float,"Minimum distance to the shore below which wind turbines cannot be build. Such areas close to the shore are excluded in the process of calculating the AC-connected offshore wind potential." +potential,--,"One of {'simple', 'conservative'}",TODO +clip_p_max_pu,p.u.,float,"To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/onwind.csv b/doc/configtables/onwind.csv index d0bcdc51..b1fd80ff 100644 --- a/doc/configtables/onwind.csv +++ b/doc/configtables/onwind.csv @@ -5,9 +5,9 @@ resource,,, -- turbine,--,"One of turbine types included in `atlite `_","Specifies the turbine type and its characteristic power curve." capacity_per_sqkm,MW/km2,float,"Allowable density of wind turbine placement." corine,,, --- grid_codes,--,"Any subset of the `CORINE Land Cover code list `_",TODO --- distance,m,float, --- distance_grid_codes,--,"Any subset of the `CORINE Land Cover code list `_",TODO -natura,--,E,TODO -potential,--,E,TODO -clip_p_max_pu,--,E,TODO \ No newline at end of file +-- grid_codes,--,"Any subset of the `CORINE Land Cover code list `_","Specifies areas according to CORINE Land Cover codes which are generally eligible for wind turbine placement." +-- distance,m,float,"Distance to keep from areas specified in ``distance_grid_codes``" +-- distance_grid_codes,--,"Any subset of the `CORINE Land Cover code list `_","Specifies areas according to CORINE Land Cover codes to which wind turbines must maintain a distance specified in the setting ``distance``." +natura,bool,"{true, false}","Switch to exclude `Natura 2000 `_ natural protection areas. Area is excluded if ``true``." +potential,--,"One of {'simple', 'conservative'}","TODO" +clip_p_max_pu,p.u.,float,"To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/plotting.csv b/doc/configtables/plotting.csv index 30ad96f8..b8723cf8 100644 --- a/doc/configtables/plotting.csv +++ b/doc/configtables/plotting.csv @@ -1,6 +1,6 @@ ,Unit,Values,Description -map,--,{'E'},TODO --- figsize,--,E,TODO +map,,, +-- figsize,--,"[width, height]; e.g. [7, 7]","Figure size in inches." -- boundaries,--,E,TODO -- p_nom,--,E,TODO -- -- bus_size_factor,--,E,TODO diff --git a/doc/configtables/solar.csv b/doc/configtables/solar.csv index ca2a237e..e823142d 100644 --- a/doc/configtables/solar.csv +++ b/doc/configtables/solar.csv @@ -1,14 +1,14 @@ ,Unit,Values,Description -cutout,--,{'E'},TODO -resource,--,E,TODO --- method,--,E,TODO --- panel,--,E,TODO --- orientation,--,E,TODO --- -- slope,--,E,TODO --- -- azimuth,--,E,TODO -capacity_per_sqkm,--,E,TODO -correction_factor,--,E,TODO -corine,--,E,TODO -natura,--,E,TODO -potential,--,E,TODO -clip_p_max_pu,--,E,TODO \ No newline at end of file +cutout,--,"One of {'europe-2013-era5', 'europe-2013-sarah'}","Specifies the directory where the relevant weather data ist stored that is specified at ``atlite/cutouts`` configuration. Both ``sarah`` and ``era5`` work." +resource,,, +-- method,--,"Must be 'pv'","A superordinate technology type." +-- panel,--,"One of {'Csi', 'CdTe', 'KANENA'} as defined in `atlite `_","Specifies the solar panel technology and its characteristic attributes." +-- orientation,,, +-- -- slope,°,"Realistically any angle in [0., 90.]","Specifies the tilt angle (or slope) of the solar panel. A slope of zero corresponds to the face of the panel aiming directly overhead. A positive tilt angle steers the panel towards the equator." +-- -- azimuth,°,"Any angle in [0., 360.]","Specifies the `azimuth `_ orientation of the solar panel. South corresponds to 180.°." +capacity_per_sqkm,:math:`MW/km^2`,float,"Allowable density of solar panel placement." +correction_factor,--,float,"A correction factor for the capacity factor (availability) time series." +corine,--,"Any subset of the `CORINE Land Cover code list `_","Specifies areas according to CORINE Land Cover codes which are generally eligible for solar panel placement." +natura,bool,"{true, false}","Switch to exclude `Natura 2000 `_ natural protection areas. Area is excluded if ``true``." +potential,--,"One of {'simple', 'conservative'}",TODO +clip_p_max_pu,p.u.,float,"To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/solving-options.csv b/doc/configtables/solving-options.csv index d1685336..88c6494c 100644 --- a/doc/configtables/solving-options.csv +++ b/doc/configtables/solving-options.csv @@ -1,8 +1,8 @@ ,Unit,Values,Description -formulation,--,{'E'},TODO +formulation,--,"Any of {'angles', 'kirchhoff', 'cycles', 'ptdf'}","Specifies which variant of linearized power flow formulations to use in the optimisation problem. Recommended is 'kirchhoff'. Explained in `this article `_." load_shedding,--,E,TODO -noisy_costs,--,E,TODO -min_iterations,--,E,TODO -max_iterations,--,E,TODO -nhours,--,E,TODO -clip_p_max_pu,--,E,TODO \ No newline at end of file +noisy_costs,bool,"{'true','false'}","Add random noise to marginal cost of generators by :math:`\mathcal{U}(0.009,0,011)` and capital cost of lines and links by :math:`\mathcal{U}(0.09,0,11)`." +min_iterations,--,int,"Minimum number of solving iterations in between which resistance and reactence (``x/r``) are updated for branches according to ``s_nom_opt`` of the previous run." +max_iterations,--,int,"Maximum number of solving iterations in between which resistance and reactence (``x/r``) are updated for branches according to ``s_nom_opt`` of the previous run." +nhours,--,int,"Specifies the :math:`n` first snapshots to take into account. Must be less than the total number of snapshots. Rather recommended only for debugging." +clip_p_max_pu,p.u.,float,"To avoid too small values in the renewables` per-unit availability time series values below this threshold are set to zero." \ No newline at end of file diff --git a/doc/configtables/transformers.csv b/doc/configtables/transformers.csv index 8276f0e0..b58ae8f3 100644 --- a/doc/configtables/transformers.csv +++ b/doc/configtables/transformers.csv @@ -1,4 +1,4 @@ ,Unit,Values,Description -x,--,{'E'},TODO -s_nom,--,E,TODO -type,--,E,TODO \ No newline at end of file +x,p.u.,float,"Series reactance (per unit, using ``s_nom`` as base power of the transformer. Overwritten if ``type`` is specified." +s_nom,MVA,float,"Limit of apparent power which can pass through branch. Overwritten if ``type`` is specified." +type,--,"A `transformer type in PyPSA `_.","Specifies transformer types to assume for the transformers of the ENTSO-E grid extraction." \ No newline at end of file