.. SPDX-FileCopyrightText: PyPSA-Earth and PyPSA-Eur Authors .. .. SPDX-License-Identifier: CC-BY-4.0 ########################################## Release Notes ########################################## Upcoming release ================ Please add descriptive release notes like in `PyPSA-Eur `__. E.g. if a new rule becomes available describe how to use it `snakemake -j1 run_tests` and in one sentence what it does. **New Features and major Changes** PyPSA-Earth 0.2.3 ================= **New Features and major Changes (19th October 2023)** * Add params: section in rule definition to keep track of changed settings in config.yaml. `PR #823 `__ and `PR #880 `__ * Fix Natural Gas implementation in "add_electricity" to avoid "Natural Gas" to be filtered out `PR #797 `__ * Improve network simplification routine to account for representation HVDC as Line component `PR #743 `__ * Remove deprecated pypsa.networkclustering approach and replace by pypsa.clustering.spatial `PR #786 `__ * Drop code-dependency from vresutil `PR #803 `__ * Add a check to ensure match between a cutout and a modelled area `PR #805 `__ * Support renewables or renewable expansion to meet a desired share of total load. `PR #793 `__ * Add NorthAmerican and Earth cutouts, and improve African cutout `PR #813 `__ * Bug fixing to restore Africa execution and improve performances `PR #817 `__ * Add Asian cutout `PR #826 `__ * Add a cutout for Western Asia `PR #837 `__ * Add osm_config yaml file `PR #822 `__ * Re-enable offshore wind and revise hydro `PR #830 `__ * Add databundle of cutouts for Kazakhstan for CI test `PR #856 `__. The bundle (~5MB) is used in pypsa-kz-data repository during CI tests. * Option to specify a global upper capacity limit (using existing BAU functionality) `PR #857 `__ * Add cluster options `all`, `min` and `flex` `PR #848 `__ * Add commit id of pypsa earth in the n.meta of the .nc file per default `PR #863 `__ PyPSA-Earth 0.2.2 ================= **New Features and major Changes (8th July 2023)** * Fix Natural Gas assignment bug in build_powerplants rule `PR #754 `__. * Add GEM datasets to the powerplantmatching config `PR #750 `__. * Add merge and replace functionalities when adding custom powerplants `PR #739 `__. "Merge" combined the powerplantmatching data with new custom data. "Replace" allows to use fully self-collected data. * Add functionality of attaching existing renewable caapcities from custom_powerplants.csv. `PR #744 `__. If custom_powerplants are enabled and custom_powerplants.csv contains wind or solar powerplants, then p_nom and p_nom_min for renewables are extracted from custom_powerplants.csv, aggregated for each bus, and set. * Fix dask parallel computations for e.g. cutouts calculations. Now again more than 1 core will be used when available that can lead to ~8x speed ups with 8 cores `PR #734 `__ and `PR #761 `__. * Add the usage of custom rules. Custom rule files must be specified in the config as a list, e.g. custom rules: ["my_rules.smk"]. Empty by default (i.e. no custom rules). `PR #755 `__ * Add trailing whitespace linter which removes unnecessary tabs when running `pre-commit` `PR #762 `__ * Add codespell linter which corrects word spellings `PR #763 `__ * Remove RES addition functionality from attach_conventional_generators `PR #769 `__. Currently wind and solar powerplants stored in powerplants.csv are added to the network by attach_conventional_generators. * Add functionalities to download and extract emission of countries. `PR #748 https://github.com/pypsa-meets-earth/pypsa-earth/pull/748` PyPSA-Earth 0.2.1 ================= **New Features and major Changes (20th May 2023)** * Fix bug. Add graphviz to docs to compile workflows in the documentation and adapt release notes `PR #719 `__ * License change from GPL to AGPL as voted `here `__ * Fix hard-coded simplification of lines to 380kV `PR #732 `__. It is now possible to simplify the network to any other voltage level with config option `base_voltage`. * Fix a KeyError in simplify_links caused by misinterpretation of AC lines as DC ones `PR #740 `__. PyPSA-Earth 0.2.0 ================= **New Features and major Changes (7th May 2023)** * Finalize package restructuring `PR #462 `__ * Fix made in config.default and config.tutorial changing Monte-Carlo from true to false `PR #463 `__ * Add new config test design. It is now easy and light to test multiple configs `PR #466 `__ * Revision of documentation `PR #471 `__ * Move to new GADM version `PR #478 `__ * Update natura tiff to global scale, revise default databundle description and remove old limitations to environment `PR #470 `__ and `PR #500 `__ * Update docs on installation `PR #498 `__ * Update docs on tutorial `PR #507 `__ * Moved from pycountry to country_converter `PR #493 `__ * Fix workflow in order to solve the landlock countries bug `PR #481 `__ and `PR #517 `__ * Add meta data of config to pypsa network per default. Allows keeping track of the config used to generate the network `PR #526 `__ * Fix renewable profiles generation for possible data loss in ERA5-derived cutouts `PR #511 `__ * Adapt dependencies of powerplantmatching to the PyPSA main branch `PR #527 `__ * Calculate the outputs of retrieve_databundle dynamically depending on settings `PR #529 `__ * Fix shape bug in the Voronoi cell creation `PR #541 `__ * Adapt dependencies on PyPSA to the PyPSA main branch `PR #538 `__ * Fix None geometries into regions `PR #546 `__ * Swap OpenStreetMap python download interface from esy-osm to earth-osm `PR #547 `__ * Restore saving of logger outputs `PR #559 `__ * Techno-economic parameters of technologies (e.g. costs and efficiencies) can be now retrieved from a separate repository `PyPSA/technology-data `_ that collects assumptions from a variety of sources. It is activated by default with ``enable: retrieve_cost_data: true`` and controlled with ``costs: year:`` and ``costs: version:``. The location of this data changed from ``data/costs.csv`` to ``resources/costs.csv``. Adapted from [`#184 `_]. * Added approaches to process contended areas `PR #572 `__ * Improve parallel capabilities of build_shapes to enable parallelization even within a country shape `PR #575 `__ * Add pypsa-eur scenario management `PR #577 `__ * Minor bug fixing and improvements `PR #580 `__ * Streamline default configuration file `PR #589 `__ * Fix rule run_test, remove code duplication, add gitstars to readme `PR #593 ` * Add new build_demand_profiles.py. It builds demand_profiles.csv and allow easier interfacing of new data `PR #582 `__ * Upgrade technology data to v0.5.0 `PR #600 `__ * Update simplify_network and cluster_network according to PyPSA-Eur developments `PR #597 `__ * Revise OSM cleaning to improve the cleaning process and error resilience `PR #620 `__ * Fix isolated buses when simplifying the network and add clustering by networks `PR #632 `__ * Include hydro runoff normalization `PR #631 `__ * Add REUSE compatibility `PR #651 `__ * Fix bug of missing GitHub issue template `PR #660 `__ * Fix GADM bug when using alternative clustering and store gadm shape with two letter instead of three letter ISO code `PR #670 `__ * Fix GADM naming bug related to level-2 clustering `PR #684 `__ * Fix append bug in build_powerplants rule `PR #686 `__ * Add *zenodo_handler.py* to update and upload files via code `PR #688 `__ * Fix a few typos in docstrings `PR #695 `__ * Update and improve configuration section in documentation `PR #694 `__ * Improve earth coverage and add improve make_statistics coverage `PR #654 `__ * Fix bug for missing renewable profiles and generators `PR #714 `__ * Update instructions on how to write documentation. `PR #720 `__ * Enable workflow to run including countries with empty OSM data, test on all UN countries `PR #701 https://github.com/pypsa-meets-earth/pypsa-earth/pull/701`__ PyPSA-Earth 0.1.0 ================= Model rebranded from PyPSA-Africa to PyPSA-Earth. Model is part of the now called PyPSA meets Earth initiative which hosts multiple projects. **New features and major changes (10th September 2022)** * Identify DC lines but temporary transform them back into AC `PR #348 `__ * Get renewable capacities from IRENA statistics `PR #343 `__ * Bug fixing (script retrieve_databundle) and rule run_test to ease testing `PR #322 `__ * Handling non-numerical entries in raw OSM data: `PR #287 `__ * General user experience improvements: `PR #326 `__ * Fix minor validation notebook inaccuracy: `PR #332 `__ * Make clean_osm_data script work with land-locked country: `PR #341 `__ * Add demand validation notebook for 2030 prediction: `PR #344 `__ * Revise build_powerplants with new version of powerplantmatching: `PR #342 `__ * Fix typo causing the wrong coordinate reference systems (CRS) to be used when determining available land types using CLC `PR #345 `__ * Add high resolution population raster via API: `PR #325 `_ * Fix bounds of cutouts aka weather cells: `PR #347 `_ * Add new countries and update iso code: `PR #330 `_ * Fix solar pv slope and add correction factor for wake losses: `PR #335 `_ * Add renewable potential notebook: `PR #351 `_ * Make cutout workflow simpler: `PR #352 `_ * Add option to run workflow without pop and gdp raster: `PR #353 `_ * Add latitude_optimal to get optimal solar orientation by default: `Commit 1b2466b `_ * Harmonize CRSs by options: `PR #356 `_ * Fix powerplantmatching problem for DRC and countries with multi-word name: `PR #359 `_ * Change default option for build_natura: `PR #360 `_ * Add renewable potential validation notebook and update others: `PR #363 `_ and `PR #369 `_ * Constrain rasterio version and add plotting dependencies: `PR #365 `_ * Change solar power density form 1.7 to 4.6 MW/km2: `PR #364 `_ * Bug fixing of unexpected float value in build_powerplants: `PR #372 `_ and `PR #373 `_ * Revise hydro capacities, add hydro validation notebook and minor revisions: `PR #366 `_ * Revise dropnan for regions: `PR #366 `_ * Fix bug in GADM clustering. Missing crs input: `PR #379 `_ * Optimise `availabilitymatrix` speed by factor 4-5: `PR #380 `_ * Fix bug in inline documentation for GADM and Voronoi clustering: `PR #384 `_ * Fix simple clustering enabling the creation of networks such `regions_onshore_elec_s54_14.nc`: `PR #386 `_ * Add transformer components which connect different voltage level lines: `PR #389 `_ * Enable the use of a float value for the scale in load_options: `PR #397 `_ * Add operational reserve margin according to PyPSA-Eur: `PR #399 `_ * Add optional normalization of hydro inflows by hydro_capacities or eia stats: `PR #376 `_ * Enable DC carrier in the network model and include converters into the model: `PR #392 `_ * Implement PyPSA-Eur improvements. Add gas limit constraints, add marginal cost sweeps wildcard, add and harmonize aggregation strategies, improve config usability by carrier clarifications, ease debugging by removing snakemake inputs from functions: `PR #402 `_ * Fix and add docs. Fix incomplete tutorial, recommend mamba for installation, add YouTube videos `PR #412 `_ and `PR #423 `_ * Restructure the package to ease readability and fix google drive downloading method: `PR #355 `_ * Update config links to adhere to the new structure of the package: `PR #420 `_ * Improve and finalize capacity_validation notebook: `PR #406 `_ and `PR #455 `_ * Fix hydro technology with the GADM clustering approach: `PR #428 `_ * Adapt for a custom shapefile for MA as a first step towards generalizing the feature: `PR #429 `_ * Improve line augmentation for network expansion explorations. Use k-edge augmenation for AC lines and random sampling for long HVDC lines: `PR #427 `_ * Fix minor bug in clustering about missing prefix assignment `PR #434 `_ * Fix major aggregation bug and adjust config: `PR #435 `_ * Fix nan techtype and wrong tech for nuclear which improves the representation of existing powerplants `PR #436 `_ * Add notebook to compare results by different solvers `PR #421 `_ * Fix overestimation of the network capacity by simplify network `PR #443 `_ * Fix output electricity column in clean_data `PR #441 `_ * Bug fixing to download global OSM and shape data: `PR #433 `_ PyPSA-Africa 0.0.2 ================== **New features and major changes (6th April 2022)** * Plotting and summary features: `PR #211 `__ and `PR #214 `__ * Templates for issue, PR, feature request: `PR #216 `__ * Attach hydro enabled with all hydro types: `PR #232 `__ * Parallel download of osm data: `PR #232 `__ * Decoupling iso coding from geofabrik; rule download_osm_data extended to the world: `PR #236 `__ * Rule build_shape extended to the world: `PR #236 `__ * Validation of geofabrik links: `PR #249 `__ * Generalized version of Data retrieval with google and zenodo hosting platforms: `PR #242 `__ and `PR #260 `__ * Fix random state for kmean clustering, adopted from `PR 313 `__ * Implement area exclusions based on land type using the Copernicus Land Cover: `PR #272 `__. * Flexible demand extraction for multiple years across the globe: `PR #275 `_ * Add CI caching and windows CI: `Commit CI windows `__, `PR #277 `__. * Change config to allow weather year extraction from snapshots as default: `PR #301 `__. * Replace Restyler by .pre-commit `PR #307 https://github.com/pypsa-meets-earth/pypsa-earth/pull/307`__. * Solved the issue of "overpassing nodes" and restyling osm_build_network: `PR #294 `__ * Revise deprecations in build_shape: `PR #315 `__ PyPSA-Africa 0.0.1 ================== This is the first release of PyPSA-Africa which heavily builds on `PyPSA-Eur `__. **New features and major changes (24th December 2021)** * Include new data streams for Africa model * Demand data implementation from `GEGIS `__. Demand can be chosen for weather years and socioeconomic `ssp` scenarios * Network is built, cleaned and processed solely on `OpenStreetMap data `__ * Voronoi regions, where data is aggregated towards, can be replaced by administrative `GADM zones `__ * `Augmented line expansion feature `__ can make network meshed, connect isolated mini-grids to the main-grid. * Community moved to `Discord `__. * Most meeting and agenda's are `open `__. Release Process =============== * Checkout a new release branch ``git checkout -b release-v0.x.x``. * Finalise release notes at ``doc/release_notes.rst``. * Update ``envs/environment.fixed.yaml`` via ``conda env export -n pypsa-earth -f envs/environment.fixed.yaml --no-builds`` from an up-to-date `pypsa-earth` environment. Add license note at the top of the new yaml. * Update version number in ``doc/conf.py`` and ``*config.*.yaml``. * Open, review and merge pull request for branch ``release-v0.x.x``. Make sure to close issues and PRs or the release milestone with it (e.g. closes #X). Run ``pre-commit run --all`` locally and fix any issues. * Tag a release on Github via ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message. * Upload code to `zenodo code repository `_ with `GPLv3 license `_. * Create pre-built networks for ``config.default.yaml`` by running ``snakemake -j 1 extra_components_all_networks``. * Upload pre-built networks to `zenodo data repository `_ with `CC BY 4.0 `_ license. * Send announcement on the `PyPSA-Earth Discord channel `_.