Skip to content

Commit

Permalink
Merge pull request #384 from pz-max/doc-bug
Browse files Browse the repository at this point in the history 
Fix documentation bug for GADM clustering
  • Loading branch information
@pz-max
pz-max authored Jun 16, 2022
2 parents 2a4d4be + 5c4e508 commit 285a870
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 69 deletions.
13 changes: 6 additions & 7 deletions config.default.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ augmented_line_connection:
min_expansion: 1 # New created line expands by float/int input [MW]

cluster_options:
alternative_clustering: false # Cluster on "False" GADM shapes, "True" Voronoi cells
alternative_clustering: false # "False" use Voronoi shapes, "True" use GADM shapes
distribute_cluster: ['load'] # Distributes cluster nodes per country according to ['load'],['pop'] or ['gdp']
out_logging: true # When "True", logging is printed to console

build_shape_options:
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
worldpop_method: "standard" # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster, false (not "false") no pop addition to shape which is useful when generating only cutout
gdp_method: "standard" # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout

Expand All @@ -77,7 +77,6 @@ build_osm_network: # Options of the build_osm_network script; osm = OpenStreetM
split_overpassing_lines: true # When True, lines overpassing buses are splitted and connected to the bueses
overpassing_lines_tolerance: 1 # [m] (default 1) Tolerance to identify lines overpassing buses


base_network:
min_voltage_substation_offshore: 35000 # [V] minimum voltage of the offshore substations
min_voltage_rebase_voltage: 35000 # [V] minimum voltage in base network
Expand Down
60 changes: 30 additions & 30 deletions config.tutorial.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ countries: ["NG", "BJ"]
#["MA"] # Morroco
#["ZA"] # South Africa

summary_dir: results

snapshots:
start: "2013-03-1"
end: "2013-03-14"
inclusive: "left" # end is not inclusive

enable:
# prepare_links_p_nom: false
retrieve_databundle: true
download_osm_data: true
# If "build_cutout" : true # requires cds API key https://cds.climate.copernicus.eu/api-how-to
# More information https://atlite.readthedocs.io/en/latest/introduction.html#datasets
build_cutout: false
build_natura_raster: true # If True, then build_natura_raster can be run

# definition of the Coordinate Reference Systems
crs:
geo_crs: EPSG:4326 # general geographic projection, not used for metric measures. "EPSG:4326" is the standard used by OSM and google maps
distance_crs: EPSG:3857 # projection for distance measurements only. Possible recommended values are "EPSG:3857" (used by OSM and Google Maps)
area_crs: ESRI:54009 # projection for area measurements only. Possible recommended values are Global Mollweide "ESRI:54009"

# download_osm_data_nprocesses: 10 # (optional) number of threads used to download osm data

augmented_line_connection:
add_to_snakefile: true
connectivity_upgrade: 3 # min. lines connection per node, https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation.html#networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation
Expand All @@ -36,17 +60,17 @@ augmented_line_connection:

# if True clusters to GADM shapes, if False Voronoi cells will be clustered
cluster_options:
alternative_clustering: false
alternative_clustering: false # "False" use Voronoi shapes, "True" use GADM shapes
distribute_cluster: ['load'] # ['load'],['pop'] or ['gdp']
out_logging: true # When true, logging is printed to console

# options for build_shapes
build_shape_options:
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
worldpop_method: "standard" # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster, false (not "false") no pop addition to shape which is useful when generating only cutout
gdp_method: "standard" # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout

Expand All @@ -57,14 +81,12 @@ clean_osm_data_options:
add_line_endings: true # When true, the line endings are added to the dataset of the substations
generator_name_method: OSM # Methodology to specify the name to the generator. Options: OSM (name as by OSM dataset), closest_city (name by the closest city)


build_osm_network: # Options of the build_osm_network script; osm = OpenStreetMap
group_close_buses: true # When "True", close buses are merged and guarantee the voltage matching among line endings
group_tolerance_buses: 500 # [m] (default 500) Tolerance in meters of the close buses to merge
split_overpassing_lines: true # When True, lines overpassing buses are splitted and connected to the bueses
overpassing_lines_tolerance: 1 # [m] (default 1) Tolerance to identify lines overpassing buses


base_network:
min_voltage_substation_offshore: 35000 # [V] minimum voltage of the offshore substations
min_voltage_rebase_voltage: 35000
Expand All @@ -75,28 +97,6 @@ load_options:
prediction_year: 2030 # Load scenarios available with different prediction year (GDP, population)
scale: 1 # scales all load time-series, i.e. 2 = doubles load

summary_dir: results

snapshots:
start: "2013-03-1"
end: "2013-03-14"
inclusive: "left" # end is not inclusive

enable:
# prepare_links_p_nom: false
retrieve_databundle: true
download_osm_data: true
# If "build_cutout" : true # requires cds API key https://cds.climate.copernicus.eu/api-how-to
# More information https://atlite.readthedocs.io/en/latest/introduction.html#datasets
build_cutout: false
build_natura_raster: true # If True, then build_natura_raster can be run

# definition of the Coordinate Reference Systems
crs:
geo_crs: EPSG:4326 # general geographic projection, not used for metric measures. "EPSG:4326" is the standard used by OSM and google maps
distance_crs: EPSG:3857 # projection for distance measurements only. Possible recommended values are "EPSG:3857" (used by OSM and Google Maps)
area_crs: ESRI:54009 # projection for area measurements only. Possible recommended values are Global Mollweide "ESRI:54009"

electricity:
voltages: [220., 300., 380.]
co2limit: 7.75e+7 # 0.05 * 3.1e9*0.5
Expand Down
2 changes: 2 additions & 0 deletions doc/release_notes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ Upcoming Release

* Optimise `availabilitymatrix` speed by factor 4-5. `PR #380 <https://github.com/pypsa-meets-africa/pypsa-africa/pull/380>`

* Fix bug in inline documentation for GADM and Voronoi clustering. `PR #384 <https://github.com/pypsa-meets-africa/pypsa-africa/pull/384>`

PyPSA-Africa 0.0.2 (6th April 2022)
=====================================

Expand Down
62 changes: 30 additions & 32 deletions test/config.test1.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,33 @@ countries: ["NG", "BJ"]
#["MA"] # Morroco
#["ZA"] # South Africa

summary_dir: results

snapshots:
start: "2013-03-1"
end: "2013-03-8"
inclusive: "left" # end is not inclusive

enable:
retrieve_databundle: true # Recommended 'true', for the first run. Otherwise data might be missing.
download_osm_data: true # If 'true', OpenStreetMap data will be downloaded for the above given countries
build_natura_raster: true # If True, than an exclusion raster will be build
build_cutout: false
# If "build_cutout" : true, then environmental data is extracted according to `snapshots` date range and `countries`
# requires cds API key https://cds.climate.copernicus.eu/api-how-to
# More information https://atlite.readthedocs.io/en/latest/introduction.html#datasets

# definition of the Coordinate Reference Systems
crs:
geo_crs: EPSG:4326 # general geographic projection, not used for metric measures. "EPSG:4326" is the standard used by OSM and google maps
distance_crs: EPSG:3857 # projection for distance measurements only. Possible recommended values are "EPSG:3857" (used by OSM and Google Maps)
area_crs: ESRI:54009 # projection for area measurements only. Possible recommended values are Global Mollweide "ESRI:54009"

retrieve_databundle:
show_progress: false # Option to disable the progress bar in retrieve_databundle

download_osm_data_nprocesses: 4 # (optional) number of threads used to download osm data

augmented_line_connection:
add_to_snakefile: false
connectivity_upgrade: 3 # min. lines connection per node, https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation.html#networkx.algorithms.connectivity.edge_augmentation.k_edge_augmentation
Expand All @@ -40,36 +64,33 @@ augmented_line_connection:

# if True clusters to GADM shapes, if False Voronoi cells will be clustered
cluster_options:
alternative_clustering: false
alternative_clustering: false # "False" use Voronoi shapes, "True" use GADM shapes
distribute_cluster: ['load'] # ['load'],['pop'] or ['gdp']
out_logging: true # When true, logging is printed to console

# options for build_shapes
build_shape_options:
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
gadm_layer_id: 1 # 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: false # When true, all the input files are downloaded again and replace the existing files
out_logging: true # When true, logging is printed to console
year: 2020 # reference year used to derive shapes, info on population and info on GDP
nprocesses: 5 # number of processes to be used in build_shapes
worldpop_method: "standard" # "standard" pulls from web 1kmx1km raster, "api" pulls from API 100mx100m raster, false (not "false") no pop addition to shape which is useful when generating only cutout
gdp_method: "standard" # "standard" pulls from web 1x1km raster, false (not "false") no gdp addition to shape which useful when generating only cutout


clean_osm_data_options:
names_by_shapes: true # Set the country name based on the extended country shapes
threshold_voltage: 35000 # [V] minimum voltage threshold to keep the asset (cable, line, generator, etc.) [V]
tag_substation: "transmission" # needed feature tag to be considered for the analysis. If empty, no filtering on the tag_substation is performed
add_line_endings: true # When true, the line endings are added to the dataset of the substations
generator_name_method: OSM # Methodology to specify the name to the generator. Options: OSM (name as by OSM dataset), closest_city (name by the closest city)


build_osm_network: # Options of the build_osm_network script; osm = OpenStreetMap
group_close_buses: true # When "True", close buses are merged and guarantee the voltage matching among line endings
group_tolerance_buses: 500 # [m] (default 500) Tolerance in meters of the close buses to merge
split_overpassing_lines: true # When True, lines overpassing buses are splitted and connected to the bueses
overpassing_lines_tolerance: 1 # [m] (default 1) Tolerance to identify lines overpassing buses


base_network:
min_voltage_substation_offshore: 35000 # [V] minimum voltage of the offshore substations
min_voltage_rebase_voltage: 35000
Expand All @@ -80,29 +101,6 @@ load_options:
prediction_year: 2030 # Load scenarios available with different prediction year (GDP, population)
scale: 1 # scales all load time-series, i.e. 2 = doubles load

summary_dir: results

snapshots:
start: "2013-03-1"
end: "2013-03-8"
inclusive: "left" # end is not inclusive

enable:
retrieve_databundle: true # Recommended 'true', for the first run. Otherwise data might be missing.
download_osm_data: true # If 'true', OpenStreetMap data will be downloaded for the above given countries
build_natura_raster: true # If True, than an exclusion raster will be build
build_cutout: false
# If "build_cutout" : true, then environmental data is extracted according to `snapshots` date range and `countries`
# requires cds API key https://cds.climate.copernicus.eu/api-how-to
# More information https://atlite.readthedocs.io/en/latest/introduction.html#datasets

# definition of the Coordinate Reference Systems
crs:
geo_crs: EPSG:4326 # general geographic projection, not used for metric measures. "EPSG:4326" is the standard used by OSM and google maps
distance_crs: EPSG:3857 # projection for distance measurements only. Possible recommended values are "EPSG:3857" (used by OSM and Google Maps)
area_crs: ESRI:54009 # projection for area measurements only. Possible recommended values are Global Mollweide "ESRI:54009"

download_osm_data_nprocesses: 4 # (optional) number of threads used to download osm data

electricity:
voltages: [220., 300., 380.]
Expand Down

0 comments on commit 285a870

Please sign in to comment.