From 67fbefaee1875b04f8c1157f164e5242f2d0a662 Mon Sep 17 00:00:00 2001 From: romainsacchi Date: Sat, 12 Oct 2024 17:03:59 +0200 Subject: [PATCH] Update docs --- docs/consequential.rst | 8 ++-- docs/extract.rst | 97 ++++++++++++++++++++++++------------------ docs/faq.rst | 6 +-- docs/introduction.rst | 1 + 4 files changed, 62 insertions(+), 50 deletions(-) diff --git a/docs/consequential.rst b/docs/consequential.rst index f3513ff2..466e25fe 100644 --- a/docs/consequential.rst +++ b/docs/consequential.rst @@ -3,8 +3,8 @@ Consequential modelling The premise module allows users to import and adjust the consequential system model of the ecoinvent database -v3.8 and 3.9, with a focus on electricity and fuel markets. -This work is based on a publication with available +v.3.8, v.3.9 and v.3.10, with a focus on electricity and fuel markets. +This work is based on a publication available at https://doi.org/10.1016/j.rser.2023.113830 If you use this module, please cite the publication: @@ -15,8 +15,7 @@ Renewable and Sustainable Energy Reviews, Volume 188, 2023, doi: 10.1016/j.rser.2023.113830 Currently, the identification of marginal supplying -technologies is limited -to the electricity and fuel sectors. +technologies is limited to the electricity and fuel sectors. Some technologies are excluded from the marginal markets due to constraints on their feedstock availability. @@ -24,7 +23,6 @@ This typically applies to waste-to-energy (e.g., waste-based CHP) or waste-to-fuel (e.g., residue-based biofuel) plants. For steel markets, only the BF-BOF route is considered. - Some imported inventories cannot be directly linked to the ecoinvent consequential database. To address this, a mapping file is provided under diff --git a/docs/extract.rst b/docs/extract.rst index fc37a16e..235aa5d5 100644 --- a/docs/extract.rst +++ b/docs/extract.rst @@ -19,40 +19,40 @@ Pathway (SSP), a climate trajectory—often represented by a Representative Concentration Pathway (RCP)—and a year (e.g., SSP1, Base, 2035). -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP/RCP scenario | GMST increase by 2100 | Society/economy trend | Climate policy | REMIND | IMAGE | -+==================+=======================+====================================================================================+=============================================+=================+============+ -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP1-None | 2.3-2.8 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | None | SSP1-Base | SSP1-Base | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP1-None | ~2.2 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | National Policies Implemented (NPI). | SSP1-NPi | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP1-None | ~1.9 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Nationally Determined Contributions (NDCs). | SSP1-NDC | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP1-RCP2.6 | ~1.7 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Paris Agreement objective. | SSP1-PkBudg1150 | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP1-RCP1.9 | ~1.3 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Paris Agreement objective. | SSP1-PkBudg500 | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP2-None | ~3.5 °C | Extrapolation from historical developments. | None (eq. to RCP6) | SSP2-Base | SSP2-Base | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP2-None | ~3.3 °C | Extrapolation from historical developments. | National Policies Implemented (NPI). | SSP2-NPi | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP2-None | ~2.5 °C | Extrapolation from historical developments. | Nationally Determined Contributions (NDCs). | SSP2-NDC | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP2-RCP2.6 | 1.6-1.8 °C | Extrapolation from historical developments. | Paris Agreement objective. | SSP2-PkBudg1150 | SSP2-RCP26 | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP2-RCP1.9 | 1.2-1.4 °C | Extrapolation from historical developments. | Paris Agreement objective. | SSP2-PkBudg500 | SSP2-RCP19 | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP5-None | ~4.5 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | None | SSP5-Base | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP5-None | ~4.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | National Policies Implemented (NPI). | SSP5-NPi | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP5-None | ~3.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Nationally Determined Contributions (NDCs). | SSP5-NDC | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP5-RCP2.6 | ~1.7 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Paris Agreement objective. | SSP5-PkBudg1150 | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ -| SSP5-RCP1.9 | ~1.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Paris Agreement objective. | SSP5-PkBudg500 | | -+------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+ ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP/RCP scenario | GMST increase by 2100 | Society/economy trend | Climate policy | REMIND | IMAGE | TIAM-UCL | ++==================+=======================+====================================================================================+=============================================+=================+============+-===========+ ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP1-None | 2.3-2.8 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | None | SSP1-Base | SSP1-Base | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP1-None | ~2.2 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | National Policies Implemented (NPI). | SSP1-NPi | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP1-None | ~1.9 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Nationally Determined Contributions (NDCs). | SSP1-NDC | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP1-RCP2.6 | ~1.7 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Paris Agreement objective. | SSP1-PkBudg1150 | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP1-RCP1.9 | ~1.3 °C | Optimistic trends for human develop. and economy, driven by sustainable practices. | Paris Agreement objective. | SSP1-PkBudg500 | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP2-None | ~3.5 °C | Extrapolation from historical developments. | None (eq. to RCP6) | SSP2-Base | SSP2-Base | SSP2-Base | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP2-None | ~3.3 °C | Extrapolation from historical developments. | National Policies Implemented (NPI). | SSP2-NPi | | SSP2-RCP45 | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP2-None | ~2.5 °C | Extrapolation from historical developments. | Nationally Determined Contributions (NDCs). | SSP2-NDC | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP2-RCP2.6 | 1.6-1.8 °C | Extrapolation from historical developments. | Paris Agreement objective. | SSP2-PkBudg1150 | SSP2-RCP26 | SSP2-RCP26 | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP2-RCP1.9 | 1.2-1.4 °C | Extrapolation from historical developments. | Paris Agreement objective. | SSP2-PkBudg500 | SSP2-RCP19 | SSP2-RCP19 | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP5-None | ~4.5 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | None | SSP5-Base | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP5-None | ~4.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | National Policies Implemented (NPI). | SSP5-NPi | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP5-None | ~3.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Nationally Determined Contributions (NDCs). | SSP5-NDC | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP5-RCP2.6 | ~1.7 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Paris Agreement objective. | SSP5-PkBudg1150 | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ +| SSP5-RCP1.9 | ~1.0 °C | Optimistic trends for human develop. and economy, driven by fossil fuels. | Paris Agreement objective. | SSP5-PkBudg500 | | | ++------------------+-----------------------+------------------------------------------------------------------------------------+---------------------------------------------+-----------------+------------+------------+ .. note:: @@ -73,12 +73,11 @@ Supported versions of ecoinvent *premise* currently works with the following ecoinvent database versions: -* v.3.5, cut-off -* v.3.6, cut-off -* v.3.7, cut-off -* v.3.7.1, cut-off +* v.3.6 +* v.3.7 * **v.3.8, cut-off and consequential** -* **v.3.9/3.9.1, cut-off and consequential** +* **v.3.9, cut-off and consequential** +* **v.3.10, cut-off and consequential** Supported sources of ecoinvent @@ -131,7 +130,7 @@ store in the library folder. Any subsequent creation of databases using the same ecoinvent version will no longer require this extraction step. -If you wish to clear that cache folder, do: +If you wish to clear that cache folder (database and *premise* additional inventories), do: .. code-block:: python @@ -146,6 +145,20 @@ If you wish to clear that cache folder, do: the remaining steps can be performed using the cached data (much faster). +To clear only the *premise* additional inventories, do: + +.. code-block:: python + + from premise import * + + clear_inventory_cache() + +.. note:: + + After a version update, databases and inventories are automatically + re-extracted and re-imported. This is to ensure that the data is + consistent with the new version of *premise*. + From ecospold2 files -------------------- @@ -1428,8 +1441,8 @@ on PV panels. .. _IEA2: https://iea.blob.core.windows.net/assets/3a99654f-ffff-469f-b83c-bf0386ed8537/pv_roadmap.pdf -Current (2020) module efficiencies for all PV types are given by a 2021 report -from the Fraunhofer_ Institute. +Current (2020) module efficiencies for all PV types are given by a 2021 +report from the Fraunhofer_ Institute. The efficiencies indicated for 2050 are what has been obtained in laboratory conditions by the Fraunhofer_ Institute. In other words, it is assumed that by 2050, diff --git a/docs/faq.rst b/docs/faq.rst index 39fadc92..28151def 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -21,7 +21,7 @@ __________________________________________________ * cut-off * consequential -from version 3.6 to 3.9.1. +from version 3.6 to 3.10. How does ``premise`` use ecoinvent? __________________________________ @@ -60,8 +60,8 @@ These datapackages can be shared freely, as they do not contain any ecoinvent da IAM models ---------- -I use a different IAM than REMIND or IMAGE ... Can I still use ``premise``? -___________________________________________________________________________ +I use a different IAM than REMIND, IMAGE or TIAM-UCL ... Can I still use ``premise``? +_____________________________________________________________________________________ There is a MAPPING section in the documentation that explains how to link to a new IAM. The YAML files under ````premise``/iam_variables_mapping`` diff --git a/docs/introduction.rst b/docs/introduction.rst index 4ea4817c..cbee3693 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -187,6 +187,7 @@ Active contributors ------------------- * `Romain Sacchi `_ +* `Alvaro Hahn Menacho `_ Historical contributors -----------------------