Skip to content

Commit

Permalink
prepare release notes and amend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fneum committed Jan 5, 2024
1 parent db54006 commit 66c9513
Show file tree
Hide file tree
Showing 10 changed files with 258 additions and 101 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
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.8.1
version: 0.9.0
license: MIT
authors:
- family-names: Brown
Expand Down
2 changes: 1 addition & 1 deletion config/config.default.yaml
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.8.1
version: 0.9.0
tutorial: false

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

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
1 change: 1 addition & 0 deletions doc/configtables/costs.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
year,--,YYYY; e.g. '2030',Year for which to retrieve cost assumptions of ``resources/costs.csv``.
version,--,vX.X.X; e.g. 'v0.5.0',Version of ``technology-data`` repository to use.
rooftop_share,--,float,Share of rooftop PV when calculating capital cost of solar (joint rooftop and utility-scale PV).
social_discountrate,p.u.,float,Social discount rate to compare costs in different investment periods. 0.02 corresponds to a social discount rate of 2%.
fill_values,--,float,Default values if not specified for a technology in ``resources/costs.csv``.
capital_cost,EUR/MW,Keys should be in the 'technology' column of ``resources/costs.csv``. Values can be any float.,"For the given technologies, assumptions about their capital investment costs are set to the corresponding value. Optional; overwrites cost assumptions from ``resources/costs.csv``."
marginal_cost,EUR/MWh,Keys should be in the 'technology' column of ``resources/costs.csv``. Values can be any float.,"For the given technologies, assumptions about their marginal operating costs are set to the corresponding value. Optional; overwrites cost assumptions from ``resources/costs.csv``."
Expand Down
8 changes: 8 additions & 0 deletions doc/configtables/sector.csv
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ regional_co2 _sequestration_potential,,,
-- years_of_storage,years,float,The years until potential exhausted at optimised annual rate
co2_sequestration_potential,MtCO2/a,float,The potential of sequestering CO2 in Europe per year
co2_sequestration_cost,currency/tCO2,float,The cost of sequestering a ton of CO2
co2_sequestration_lifetime,years,int,The lifetime of a CO2 sequestration site
co2_spatial,--,"{true, false}","Add option to spatially resolve carrier representing stored carbon dioxide. This allows for more detailed modelling of CCUTS, e.g. regarding the capturing of industrial process emissions, usage as feedstock for electrofuels, transport of carbon dioxide, and geological sequestration sites."
,,,
co2network,--,"{true, false}",Add option for planning a new carbon dioxide transmission network
Expand Down Expand Up @@ -130,3 +131,10 @@ biogas_upgrading_cc,--,"{true, false}",Add option to capture CO2 from biomass up
conventional_generation,,,Add a more detailed description of conventional carriers. Any power generation requires the consumption of fuel from nodes representing that fuel.
biomass_to_liquid,--,"{true, false}",Add option for transforming solid biomass into liquid fuel with the same properties as oil
biosng,--,"{true, false}",Add option for transforming solid biomass into synthesis gas with the same properties as natural gas
limit_max_growth,,,
-- enable,--,"{true, false}",Add option to limit the maximum growth of a carrier
-- factor,p.u.,float,The maximum growth factor of a carrier (e.g. 1.3 allows 30% larger than max historic growth)
-- max_growth,,,
-- -- {carrier},GW,float,The historic maximum growth of a carrier
-- max_relative_growth,
-- -- {carrier},p.u.,float,The historic maximum relative growth of a carrier
2 changes: 1 addition & 1 deletion doc/foresight.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Perfect foresight scenarios

.. warning::

Perfect foresight is currently implemented as a first test version.
Perfect foresight is currently implemented as an experimental test version.

For running perfect foresight scenarios, you can adjust the
``config/config.perfect.yaml``:
Expand Down
13 changes: 13 additions & 0 deletions doc/preparation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ Rule ``build_electricity_demand``

.. automodule:: build_electricity_demand

.. _monthlyprices:

Rule ``build_monthly_prices``
=============================

.. automodule:: build_monthly_prices

.. _ship:

Rule ``build_ship_raster``
Expand All @@ -102,6 +109,12 @@ Rule ``build_ship_raster``

.. automodule:: build_ship_raster

.. _availabilitymatrixmdua:

Rule ``determine_availability_matrix_MD_UA``
============================================

.. automodule:: determine_availability_matrix_MD_UA

.. _renewableprofiles:

Expand Down
Loading

0 comments on commit 66c9513

Please sign in to comment.