-
Notifications
You must be signed in to change notification settings - Fork 184
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #694 from asolavi/doc_config
* Bring top-level configuration options together at the top of the configuration file. * Bring top-level configuration options together at the top of the tutorial configuration file. * Top-level configuration literalinclude displayed using more robust start-at end-before Sphinx commands * Remove depreciated options summary_dir, focus_weights, retrieve_cutout, retrieve_natura_raster, custom_busmap from top level configuration table * Add download_osm_data on top level configuration table, and organise the table to match config.default.yaml. * Add csv table in section run. * Minor adjustments in the scenario section. * Future-proof by using end-at in literalinclude instead of end-before. * snapshot section. Improve description of available years. * Add crs (coordinate reference system) section in the docs. * Add augmented_line_connection section. * Replace true/false for True/False in the table. * Replace true/false for True/False in run.csv. * Add cluster_options section in the configuration documentation. * Remove space between the version and tutorial section in the config.yaml files. * Add documentation for build_shape_options section in the configuration file. * Add section about clean_osm_data_options in the configuration documentation. * Add sections on build_osm_network and base_network in the configuration documentation. * Fixing typo in base_network section of configuration documentation. * Add load_options section in the configuration documentation. * Update and minor fixes in electricity section of the configuration documentation. * Fixing sections in cluster_options table in configuration documentation. * Fixing sections in build_shape_options table in configuration documentation. * Fixing sections in clean_osm_data_options table in configuration documentation. * Fixing sections in build_osm_network table in configuration documentation. * Fixing sections in base_newtwork table in configuration documentation. * Fixing sections in load_options table in configuration documentation. * Improve description of section cluster_options in configuration documentation. * Update lines section in the configuration docs. * Add description on electricity section. * Description details for commitable cluster_options in configuration documentation. * Improve description in load_options section of configuration documentation. * Improve Links documentation in the configuration section. * Improvements in the renewable section of the configuration documentation. * Small improvement in transformer section of configuration documentation. * Remove load section from configuration documentation. It seems to have been replaced by load_options and others. * Improve cost section of the configuration documentation. * Remove clustering section in configuration documentation. It got renamed to cluster_options. * Add description in monte_carlo section of configuration documentation. * Add description in solving section of configuration documentation. * Add description of plotting section in configuration documentation. * Improvements in the cluster_options section of the documentation. * Improve renewable section of configuration documentation. Description of the extendable feature. * Improvements in renewable section of configuration documentation. Add descriptions for hydro resource methods. * change theme, fix some warning * reintroduce setuptools as pypsa-eur docs is failing * Fix old typos --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Max Parzen <[email protected]> Co-authored-by: ekatef <[email protected]>
- Loading branch information
4 people
authored
May 6, 2023
1 parent
bf3cbea
commit ac5ed2d
Showing
48 changed files
with
497 additions
and
351 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ,Unit,Values,Description | ||
| add_to_snakefile, bool, "{True, False}", "True: includes this rule to the workflow." | ||
| connectivity_upgrade, int, "{1, 2, 3, ...}", "Number k such that the network graph is k-edge-connected." | ||
| new_line_type,, "{[""HVAC""], [""HVDC""], [""HVAC"", ""HVDC""]}", "Type of expanded lines." | ||
| min_expansion, int or float,, "[MW] New created line capacity." | ||
| min_DC_length, int or float,, "[km] Minimum line length of HVDC line." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ,Unit,Values,Description | ||
| min_voltage_substation_offshore, V,, "Minimum voltage magnitude in offshore substations." | ||
| min_voltage_rebase_voltage, V,, "Minimum voltage magnitude in base network." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ,Unit,Values,Description | ||
| group_close_buses, bool, "{True, False}", "True: close buses are merged and guarantee the voltage matching among line endings." | ||
| group_tolerance_buses, m,, "Tolerance in meters of the close buses to merge." | ||
| split_overpassing_lines, bool, "{True, False}", "True: lines overpassing buses are splitted and connected to the buses." | ||
| overpassing_lines_tolerance, m,, "Tolerance to identify lines overpassing buses." | ||
| force_ac, bool, "{True, False}", "True: forces all components (lines and substation) to be AC-only. To be used if DC assets create problems." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ,Unit,Values,Description | ||
| gadm_layer_id,, "{0, 1, 2}", "GADM level area used for the gadm_shapes. Codes are country-dependent but roughly: 0: country, 1: region/county-like, 2: municipality-like." | ||
| update_file, bool, "{True, False}", "True: all input files are downloaded again and replace the existing files." | ||
| out_logging, bool, "{True, False}", "True: Logging is printed in the console." | ||
| year,, "past year; e.g. YYYY", "Reference year used to derive shapes, info on population and info on GDP." | ||
| nprocesses, int,, "Number of processes to be used in build_shapes." | ||
| nchunks, int,, "Number of data chuncks for build_shapes. If not specified or smaller than nprocesses, specified as nprocesses." | ||
| worldpop_method,, "{""standard"", ""api"", false}", "Specifies how population is added to every shape: ""standard"" pulls from web 1kmx1km raster; ""api"" pulls from API 100mx100m raster; false (not ""false"") no population addition to shape. This is useful when generating only cutout." | ||
| gdp_method,, "{""standard"", false}", "Specifies how GDP is added to every shape: ""standard"" pulls from web 1x1km raster; false (not ""false"") no gdp addition to shape. This is useful when generating only cutout." | ||
| contended_flag,, "{""set_by_country"", ""drop""}", "Specifies what to do with contended countries: ""set_by_country"" assigns the contended areas to the countries according to the GADM database; ""drop"" drops the contended areas from the model." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ,Unit,Values,Description | ||
| names_by_shapes, bool, "{True, False}", "True: the country name is set based on the extended country shapes." | ||
| threshold_voltage, V,, "Assets below the voltage threshold will not be considered (cable, line, generator, etc.)." | ||
| tag_substation,, "{""transmission"", ""distribution""}", "Filters only substations with the corresponding tag (""transmission"" or ""distribution"")." | ||
| add_line_endings, bool, "{True, False}", "True: line endings are added to the dataset of the substations." | ||
| generator_name_method,, "{OSM, closest_city}", "Methodology to specify the name of generators. From OpenStreetMap (OSM) or named after the closest city (closest_city)." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| ,Unit,Values,Description | ||
| simplify_network,,, | ||
| -- to_substations, bool, "{True, False}", "False: network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)." | ||
| -- algorithm,, "{hac, kmeans, modularity}", "Clustering algorithm used in the simplify_network rule. Options available are Hierarchical Agglomerative Clustering (HAC), k-means, or greedy modularity." | ||
| -- feature,, "Str in the format ‘carrier1+carrier2+...+carrierN-X’, where CarrierI can be from {‘solar’, ‘onwind’, ‘offwind’, ‘ror’} and X is one of {‘cap’, ‘time’}. Examples: solar+offwind-cap, solar-time", "Only for Hierarchical Agglomerative Clustering (HAC). Feature(s) used to do the clustering." | ||
| -- exclude_carriers,, "List of Str like [ 'solar', 'onwind'] or empy list []", "Carriers not considered in the simplify_network rule. Can be any set of carriers (conventional or renewable)." | ||
| -- remove_stubs, bool, "{True, False}", "True: Stub lines and links, i.e. dead-ends of the network, are sequentially removed from the network." | ||
| -- remove_stubs_across_borders, bool, "{True, False}", "True: Stub lines and links can be removed across borders." | ||
| -- p_threshold_drop_isolated, MW, positive number, "Isolated buses are discarded if bus mean power is below the `p_threshold_drop_isolated`." | ||
| -- p_threshold_merge_isolated, MW, positive number, "Isolated buses are merged into a single isolated bus if bus mean power is below `p_threshold_merge_isolated`." | ||
| cluster_network,,, | ||
| -- algorithm,,"{hac, kmeans}", "Clustering algorithm used in the cluster_network rule. Options available are Hierarchical Agglomerative Clustering (HAC) or k-means." | ||
| -- feature,,"Str in the format ‘carrier1+carrier2+...+carrierN-X’, where CarrierI can be from {‘solar’, ‘onwind’, ‘offwind’, ‘ror’} and X is one of {‘cap’, ‘time’}. Examples: solar+offwind-cap, solar-time", "Only for Hierarchical Agglomerative Clustering (HAC). Feature(s) used to do the clustering." | ||
| -- exclude_carriers,, "List of Str like [ 'solar', 'onwind'] or empy list []", "Carriers not considered in the cluster_network rule. Can be any set of carriers (conventional or renewable)." | ||
| alternative_clustering, bool, "{True, False}", "False: use Voronoi shapes in the clustering. True: use GADM shapes in the clustering." | ||
| distribute_cluster,, "{['load'], ['pop'], ['gdp']}", "Distributes cluster nodes per country according to load (['load']), population (['pop']) or GDP (['gdp'])." | ||
| out_logging, bool, "{True, False}", "True: Logging is printed to the console." | ||
| aggregation_strategies,,, | ||
| -- generators,,, | ||
| -- -- p_nom,, "{min, mean, max, sum}", "Indicates how the p_nom of the aggregated generator is computed from the original p_nom values. For example, if sum, then all values within each cluster are summed to represent the new generator." | ||
| -- -- p_nom_max,, "{min, mean, max, sum}", "Indicates how the p_nom_max of the aggregated generator is computed from the original p_nom_max values." | ||
| -- -- p_nom_min,, "{min, mean, max, sum}", "Indicates how the p_nom_min of the aggregated generator is computed from the original p_nom_min values." | ||
| -- -- p_min_pu,, "{min, mean, max, sum}", "Indicates how the p_min_pu of the aggregated generator is computed from the original p_min_pu values." | ||
| -- -- marginal_cost,, "{min, mean, max, sum}", "Indicates how the marginal_cost of the aggregated generator is computed from the original marginal_cost values." | ||
| -- -- commitable,,"{any}", "Indicates how the commit status of the aggregated generator is set depending on the original values of the generators. Unit Commitment is currently under development, so should be left to ``any``." | ||
| -- -- ramp_limit_up,, "{min, mean, max, sum}", "Indicates how the ramp_limit_up of the aggregated generator is computed from the original ramp_limit_up values." | ||
| -- -- ramp_limit_down,, "{min, mean, max, sum}", "Indicates how the ramp_limit_down of the aggregated generator is computed from the original ramp_limit_down values." | ||
| -- -- efficiency,, "{min, mean, max, sum}", "Indicates how the efficiency of the aggregated generator is computed from the original efficiency values." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| ,Unit,Values,Description | ||
| geo_crs,, "General geographic projection. Not used for metric measures.", "Recommended value is ‘EPSG:4326’ (used by OSM and Google Maps)." | ||
| distance_crs,, "Projection for distance measurements only.", "Recommended value is ‘EPSG:3857’ (used by OSM and Google Maps)." | ||
| area_crs,, "Projection for area measurements only.", "Recommended value is the Global Mollweide projection ‘ESRI:54009’." |
Oops, something went wrong.