Documentation of each rule
Open
@JulianGeis is already working on this.
Since May 28, 2024.
documentation
- Dominant language
- Python
- Stars
- 614
- Forks
- 459
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 6
Description
The goal is to write and update detailed rule descriptions and add docstrings to script functions.
build_electricity.smk
-
prepare_links_p_nom@bobbyxng -
build_electricity_demand -
build_powerplants -
base_network@bobbyxng -
build_shapes -
build_cutout@p-glaum -
build_ship_raster@p-glaum -
determine_availability_matrix_MD_UA -
build_renewable_profiles@p-glaum -
build_monthly_prices -
build_hydro_profile -
build_line_rating -
add_electricity -
simplify_network@p-glaum + @bobbyxng -
cluster_network -
add_extra_components -
prepare_network
build_sector.smk
-
build_population_layouts@p-glaum -
build_clustered_population_layouts@p-glaum -
build_simplified_population_layouts@p-glaum -
build_gas_network@JulianGeis -
build_gas_input_locations@JulianGeis -
cluster_gas_network@JulianGeis -
build_daily_heat_demand@amosschle -
build_hourly_heat_demand@amosschle -
build_temperature_profiles@amosschle -
build_cop_profiles@amosschle -
build_solar_thermal_profiles@amosschle -
build_energy_totals@amosschle -
build_heat_totals@amosschle -
build_biomass_potentials@p-glaum -
build_biomass_transport_costs@p-glaum -
build_sequestration_potentials -
build_salt_cavern_potentials -
build_ammonia_production@toniseibold -
build_industry_sector_ratios@toniseibold -
build_industry_sector_ratios_intermediate@toniseibold -
build_industrial_production_per_country@toniseibold -
build_industrial_production_per_country_tomorrow@toniseibold -
build_industrial_distribution_key@toniseibold -
build_industrial_production_per_node@toniseibold -
build_industrial_energy_demand_per_node@toniseibold -
build_industrial_energy_demand_per_country_today@toniseibold -
build_industrial_energy_demand_per_node_today@toniseibold -
build_retro_cost -
build_population_weighted_energy_totals -
build_shipping_demand -
build_transport_demand -
build_district_heat_share@amosschle -
build_existing_heating_distribution@amosschle -
time_aggregation -
prepare_sector_network
postprocess.smk
-
plot_power_network_clustered -
plot_power_network -
plot_hydrogen_network@JulianGeis -
plot_gas_network -
plot_power_network_perfect -
make_summary -
plot_summary - (
plot_elec_statistics)
retrieve.smk
-
retrieve_databundle -
retrieve_eurostat_data -
retrieve_eurostat_household_data -
retrieve_cutout -
retrieve_cost_data -
retrieve_gas_infrastructure_data -
retrieve_electricity_demand -
retrieve_synthetic_electricity_demand -
retrieve_ship_raster -
download_copernicus_land_cover -
retrieve_luisa_land_cover -
download_wdpa -
download_wdpa_marine -
retrieve_monthly_co2_prices -
retrieve_monthly_fuel_prices
solve_electricity.smk
-
solve_network -
solve_operations_network
solve_myopic.smk
-
add_existing_baseyear -
add_brownfield -
solve_sector_network_myopic
solve_overnight.smk
-
solve_sector_network
solve_perfect.smk
-
add_existing_baseyear -
prepare_perfect_foresight -
solve_sector_network_perfect -
make_summary_perfect
validate.smk
not planned for documentation
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.