Skip to content

Commit

Permalink
prepare release v0.11.0 (#1081)
Browse files Browse the repository at this point in the history 
* prepare release notes v0.11.0

* streamline release notes

* update envs/environment.fixed.yaml

* doc: update workflow DAGs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* pre-commit formatting [no ci]

* update envs/environment.fixed.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
@fneum @pre-commit-ci
fneum and pre-commit-ci[bot] authored May 25, 2024
1 parent 7ad930e commit 1da76dd
Show file tree
Hide file tree
Showing 8 changed files with 1,430 additions and 1,124 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ cff-version: 1.1.0
message: "If you use this package, please cite it in the following way."
title: "PyPSA-Eur: An open sector-coupled optimisation model of the European energy system"
repository: https://github.com/pypsa/pypsa-eur
version: 0.10.0
version: 0.11.0
license: MIT
authors:
- family-names: Brown
Expand Down
2 changes: 1 addition & 1 deletion config/config.default.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: CC0-1.0

# docs in https://pypsa-eur.readthedocs.io/en/latest/configuration.html#top-level-configuration
version: 0.10.0
version: 0.11.0
tutorial: false

logging:
Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@
# built documents.
#
# The short X.Y version.
version = "0.10"
version = "0.11"
# The full version, including alpha/beta/rc tags.
release = "0.10.0"
release = "0.11.0"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
Binary file modified doc/img/intro-workflow.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
538 changes: 285 additions & 253 deletions doc/release_notes.rst
View file

Large diffs are not rendered by default.

102 changes: 57 additions & 45 deletions doc/tutorial.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,47 +132,51 @@ This triggers a workflow of multiple preceding jobs that depend on each rule's i
graph[bgcolor=white, margin=0];
node[shape=box, style=rounded, fontname=sans, fontsize=10, penwidth=2];
edge[penwidth=2, color=grey];
0[label = "solve_network", color = "0.38 0.6 0.85", style="rounded"];
1[label = "prepare_network\nll: copt", color = "0.53 0.6 0.85", style="rounded"];
2[label = "add_extra_components", color = "0.01 0.6 0.85", style="rounded"];
3[label = "cluster_network\nclusters: 6", color = "0.03 0.6 0.85", style="rounded"];
4[label = "simplify_network\nsimpl: ", color = "0.42 0.6 0.85", style="rounded"];
5[label = "add_electricity", color = "0.10 0.6 0.85", style="rounded"];
6[label = "build_renewable_profiles\ntechnology: solar", color = "0.50 0.6 0.85", style="rounded"];
7[label = "base_network", color = "0.22 0.6 0.85", style="rounded"];
8[label = "build_shapes", color = "0.44 0.6 0.85", style="rounded"];
9[label = "retrieve_databundle", color = "0.29 0.6 0.85", style="rounded"];
10[label = "retrieve_cutout\ncutout: be-03-2013-era5", color = "0.49 0.6 0.85", style="rounded"];
11[label = "build_renewable_profiles\ntechnology: onwind", color = "0.50 0.6 0.85", style="rounded"];
12[label = "build_renewable_profiles\ntechnology: offwind-ac", color = "0.50 0.6 0.85", style="rounded"];
13[label = "build_ship_raster", color = "0.19 0.6 0.85", style="rounded"];
14[label = "retrieve_ship_raster", color = "0.35 0.6 0.85", style="rounded"];
15[label = "build_renewable_profiles\ntechnology: offwind-dc", color = "0.50 0.6 0.85", style="rounded"];
16[label = "build_line_rating", color = "0.60 0.6 0.85", style="rounded"];
17[label = "retrieve_cost_data\nyear: 2030", color = "0.59 0.6 0.85", style="rounded"];
18[label = "build_powerplants", color = "0.06 0.6 0.85", style="rounded"];
19[label = "build_electricity_demand", color = "0.13 0.6 0.85", style="rounded"];
20[label = "retrieve_electricity_demand", color = "0.49 0.6 0.85", style="rounded"];
21[label = "retrieve_synthetic_electricity_demand", color = "0.41 0.6 0.85", style="rounded"];
0[label = "solve_network", color = "0.21 0.6 0.85", style="rounded"];
1[label = "prepare_network\nll: copt\nopts: ", color = "0.51 0.6 0.85", style="rounded"];
2[label = "add_extra_components", color = "0.43 0.6 0.85", style="rounded"];
3[label = "cluster_network\nclusters: 6", color = "0.17 0.6 0.85", style="rounded"];
4[label = "simplify_network\nsimpl: ", color = "0.49 0.6 0.85", style="rounded"];
5[label = "add_electricity", color = "0.26 0.6 0.85", style="rounded"];
6[label = "build_renewable_profiles\ntechnology: solar", color = "0.02 0.6 0.85", style="rounded"];
7[label = "base_network", color = "0.35 0.6 0.85", style="rounded"];
8[label = "build_shapes", color = "0.62 0.6 0.85", style="rounded"];
9[label = "retrieve_databundle", color = "0.24 0.6 0.85", style="rounded"];
10[label = "retrieve_cutout\ncutout: be-03-2013-era5", color = "0.36 0.6 0.85", style="rounded"];
11[label = "build_renewable_profiles\ntechnology: solar-hsat", color = "0.02 0.6 0.85", style="rounded"];
12[label = "build_renewable_profiles\ntechnology: onwind", color = "0.02 0.6 0.85", style="rounded"];
13[label = "build_renewable_profiles\ntechnology: offwind-ac", color = "0.02 0.6 0.85", style="rounded"];
14[label = "build_ship_raster", color = "0.08 0.6 0.85", style="rounded"];
15[label = "retrieve_ship_raster", color = "0.28 0.6 0.85", style="rounded"];
16[label = "build_renewable_profiles\ntechnology: offwind-dc", color = "0.02 0.6 0.85", style="rounded"];
17[label = "build_renewable_profiles\ntechnology: offwind-float", color = "0.02 0.6 0.85", style="rounded"];
18[label = "build_line_rating", color = "0.07 0.6 0.85", style="rounded"];
19[label = "retrieve_cost_data\nyear: 2030", color = "0.47 0.6 0.85", style="rounded"];
20[label = "build_powerplants", color = "0.11 0.6 0.85", style="rounded"];
21[label = "build_electricity_demand", color = "0.05 0.6 0.85", style="rounded"];
22[label = "retrieve_electricity_demand", color = "0.58 0.6 0.85", style="rounded"];
23[label = "retrieve_synthetic_electricity_demand", color = "0.11 0.6 0.85", style="rounded"];
1 -> 0
2 -> 1
17 -> 1
19 -> 1
3 -> 2
17 -> 2
19 -> 2
4 -> 3
17 -> 3
19 -> 3
5 -> 4
17 -> 4
19 -> 4
7 -> 4
6 -> 5
11 -> 5
12 -> 5
15 -> 5
7 -> 5
13 -> 5
16 -> 5
17 -> 5
7 -> 5
18 -> 5
19 -> 5
20 -> 5
21 -> 5
8 -> 5
7 -> 6
9 -> 6
Expand All @@ -186,21 +190,30 @@ This triggers a workflow of multiple preceding jobs that depend on each rule's i
10 -> 11
7 -> 12
9 -> 12
13 -> 12
8 -> 12
10 -> 12
7 -> 13
9 -> 13
14 -> 13
8 -> 13
10 -> 13
7 -> 15
9 -> 15
13 -> 15
8 -> 15
10 -> 15
15 -> 14
10 -> 14
7 -> 16
9 -> 16
14 -> 16
8 -> 16
10 -> 16
7 -> 17
9 -> 17
14 -> 17
8 -> 17
10 -> 17
7 -> 18
20 -> 19
21 -> 19
10 -> 18
7 -> 20
22 -> 21
23 -> 21
}

|
Expand All @@ -219,7 +232,7 @@ In the terminal, this will show up as a list of jobs to be run:
build_electricity_demand 1
build_line_rating 1
build_powerplants 1
build_renewable_profiles 4
build_renewable_profiles 6
build_shapes 1
build_ship_raster 1
cluster_network 1
Expand All @@ -232,7 +245,7 @@ In the terminal, this will show up as a list of jobs to be run:
retrieve_synthetic_electricity_demand 1
simplify_network 1
solve_network 1
total 22
total 24
``snakemake`` then runs these jobs in the correct order.
Expand All @@ -241,16 +254,15 @@ A job (here ``simplify_network``) will display its attributes and normally some

.. code:: bash
[Mon Feb 19 17:06:17 2024]
rule simplify_network:
input: resources/test/networks/elec.nc, data/costs_2030.csv, resources/test/regions_onshore.geojson, resources/test/regions_offshore.geojson
output: resources/test/networks/elec_s.nc, resources/test/regions_onshore_elec_s.geojson, resources/test/regions_offshore_elec_s.geojson, resources/test/busmap_elec_s.csv, resources/test/connection_costs_s.csv
log: logs/test-elec/simplify_network/elec_s.log
input: resources/test/networks/elec.nc, resources/test/costs_2030.csv, resources/test/regions_onshore.geojson, resources/test/regions_offshore.geojson
output: resources/test/networks/elec_s.nc, resources/test/regions_onshore_elec_s.geojson, resources/test/regions_offshore_elec_s.geojson, resources/test/busmap_elec_s.csv
log: logs/test/simplify_network/elec_s.log
jobid: 4
benchmark: benchmarks/test-elec/simplify_network/elec_s
reason: Missing output files: resources/test/regions_offshore_elec_s.geojson, resources/test/busmap_elec_s.csv, resources/test/regions_onshore_elec_s.geojson, resources/test/networks/elec_s.nc; Input files updated by another job: resources/test/regions_offshore.geojson, resources/test/networks/elec.nc, resources/test/regions_onshore.geojson, data/costs_2030.csv
benchmark: benchmarks/test/simplify_network/elec_s
reason: Forced execution
wildcards: simpl=
resources: tmpdir=/tmp, mem_mb=12000, mem_mib=11445
resources: tmpdir=<TBD>, mem_mb=12000, mem_mib=11445
Once the whole worktree is finished, it should state so in the terminal.

Expand Down
Loading

0 comments on commit 1da76dd

Please sign in to comment.