Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AR6 Scenario Database variables #61

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rgieseke
Copy link
Contributor

@rgieseke rgieseke commented Apr 8, 2022

Pull request

Please confirm that this pull request has done the following:

  • Tests added
  • Documentation added (where applicable)
  • Changelog snippet in a .rst file in the directory changelog_unreleased added – remember to start with a * to make it a bullet point

Description

First attempt at importing the AR6 Scenario Database variables.

@codecov
Copy link

codecov bot commented Apr 8, 2022

Codecov Report

Merging #61 (77e4cfd) into main (2734c0a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   99.35%   99.35%           
=======================================
  Files          26       27    +1     
  Lines        1395     1397    +2     
=======================================
+ Hits         1386     1388    +2     
  Misses          9        9           
Impacted Files Coverage Δ
climate_categories/data/AR6_SCEN_DB.py 100.00% <ø> (ø)
climate_categories/__init__.py 100.00% <100.00%> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@rgieseke
Copy link
Contributor Author

rgieseke commented Apr 8, 2022

Same problem as with other |-separated category systems, might still be useful, e.g. for Emissions

Emissions Emissions
├Emissions|BC Emissions|BC
│├Emissions|BC|AFOLU Emissions|BC|AFOLU
││├Emissions|BC|AFOLU|Agriculture Emissions|BC|AFOLU|Agriculture
││╰Emissions|BC|AFOLU|Land Emissions|BC|AFOLU|Land
│├Emissions|BC|Energy Emissions|BC|Energy
││╰Emissions|BC|Energy|Supply Emissions|BC|Energy|Supply
│├Emissions|BC|Industrial Processes Emissions|BC|Industrial Processes
│├Emissions|BC|Other Emissions|BC|Other
│╰Emissions|BC|Waste Emissions|BC|Waste
├Emissions|C2F6 Emissions|C2F6
├Emissions|CF4 Emissions|CF4
├Emissions|CH4 Emissions|CH4
│├Emissions|CH4|AFOLU Emissions|CH4|AFOLU
││├Emissions|CH4|AFOLU|Agriculture Emissions|CH4|AFOLU|Agriculture
│││├Emissions|CH4|AFOLU|Agriculture|Livestock Emissions|CH4|AFOLU|Agriculture|Livestock
││││├Emissions|CH4|AFOLU|Agriculture|Livestock|Enteric Fermentation Emissions|CH4|AFOLU|Agriculture|Livestock|Enteric Fermentation
││││╰Emissions|CH4|AFOLU|Agriculture|Livestock|Manure Management Emissions|CH4|AFOLU|Agriculture|Livestock|Manure Management
│││╰Emissions|CH4|AFOLU|Agriculture|Rice Emissions|CH4|AFOLU|Agriculture|Rice
││╰Emissions|CH4|AFOLU|Land Emissions|CH4|AFOLU|Land
│├Emissions|CH4|Energy Emissions|CH4|Energy
││╰Emissions|CH4|Energy|Supply Emissions|CH4|Energy|Supply
│├Emissions|CH4|Industrial Processes Emissions|CH4|Industrial Processes
││├Emissions|CH4|Industrial Processes|Chemicals Emissions|CH4|Industrial Processes|Chemicals
││╰Emissions|CH4|Industrial Processes|Steel Emissions|CH4|Industrial Processes|Steel
│├Emissions|CH4|Other Emissions|CH4|Other
│╰Emissions|CH4|Waste Emissions|CH4|Waste
├Emissions|CO2 Emissions|CO2
│├Emissions|CO2|AFOLU Emissions|CO2|AFOLU
││├Emissions|CO2|AFOLU|Agriculture Emissions|CO2|AFOLU|Agriculture
││╰Emissions|CO2|AFOLU|Land Emissions|CO2|AFOLU|Land
│├Emissions|CO2|Energy Emissions|CO2|Energy
││├Emissions|CO2|Energy|Demand Emissions|CO2|Energy|Demand
│││├Emissions|CO2|Energy|Demand|AFOFI Emissions|CO2|Energy|Demand|AFOFI
│││├Emissions|CO2|Energy|Demand|Industry Emissions|CO2|Energy|Demand|Industry
││││├Emissions|CO2|Energy|Demand|Industry|Cement Emissions|CO2|Energy|Demand|Industry|Cement
││││├Emissions|CO2|Energy|Demand|Industry|Chemicals Emissions|CO2|Energy|Demand|Industry|Chemicals
│││││├Emissions|CO2|Energy|Demand|Industry|Chemicals|Ammonia Emissions|CO2|Energy|Demand|Industry|Chemicals|Ammonia
│││││├Emissions|CO2|Energy|Demand|Industry|Chemicals|High value chemicals Emissions|CO2|Energy|Demand|Industry|Chemicals|High value chemicals
│││││├Emissions|CO2|Energy|Demand|Industry|Chemicals|Methanol Emissions|CO2|Energy|Demand|Industry|Chemicals|Methanol
│││││╰Emissions|CO2|Energy|Demand|Industry|Chemicals|Other Emissions|CO2|Energy|Demand|Industry|Chemicals|Other
││││├Emissions|CO2|Energy|Demand|Industry|Non-ferrous metals Emissions|CO2|Energy|Demand|Industry|Non-ferrous metals
││││├Emissions|CO2|Energy|Demand|Industry|Other Emissions|CO2|Energy|Demand|Industry|Other
││││├Emissions|CO2|Energy|Demand|Industry|Pulp and Paper Emissions|CO2|Energy|Demand|Industry|Pulp and Paper
││││╰Emissions|CO2|Energy|Demand|Industry|Steel Emissions|CO2|Energy|Demand|Industry|Steel
│││├Emissions|CO2|Energy|Demand|Other Sector Emissions|CO2|Energy|Demand|Other Sector
│││├Emissions|CO2|Energy|Demand|Residential and Commercial Emissions|CO2|Energy|Demand|Residential and Commercial
││││├Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial
│││││╰Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating
│││││ ├Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Cooking Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Cooking
│││││ ├Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Space Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Space
│││││ ╰Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Water Emissions|CO2|Energy|Demand|Residential and Commercial|Commercial|Heating|Water
││││╰Emissions|CO2|Energy|Demand|Residential and Commercial|Residential Emissions|CO2|Energy|Demand|Residential and Commercial|Residential
││││ ╰Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating
││││  ├Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Cooking Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Cooking
││││  ├Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Space Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Space
││││  ╰Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Water Emissions|CO2|Energy|Demand|Residential and Commercial|Residential|Heating|Water
│││╰Emissions|CO2|Energy|Demand|Transportation Emissions|CO2|Energy|Demand|Transportation
│││ ├Emissions|CO2|Energy|Demand|Transportation|Aviation Emissions|CO2|Energy|Demand|Transportation|Aviation
│││ │├Emissions|CO2|Energy|Demand|Transportation|Aviation|Freight Emissions|CO2|Energy|Demand|Transportation|Aviation|Freight
│││ │╰Emissions|CO2|Energy|Demand|Transportation|Aviation|Passenger Emissions|CO2|Energy|Demand|Transportation|Aviation|Passenger
│││ ├Emissions|CO2|Energy|Demand|Transportation|Freight Emissions|CO2|Energy|Demand|Transportation|Freight
│││ ├Emissions|CO2|Energy|Demand|Transportation|Maritime Emissions|CO2|Energy|Demand|Transportation|Maritime
│││ │├Emissions|CO2|Energy|Demand|Transportation|Maritime|Freight Emissions|CO2|Energy|Demand|Transportation|Maritime|Freight
│││ │╰Emissions|CO2|Energy|Demand|Transportation|Maritime|Passenger Emissions|CO2|Energy|Demand|Transportation|Maritime|Passenger
│││ ├Emissions|CO2|Energy|Demand|Transportation|Passenger Emissions|CO2|Energy|Demand|Transportation|Passenger
│││ ├Emissions|CO2|Energy|Demand|Transportation|Rail Emissions|CO2|Energy|Demand|Transportation|Rail
│││ │├Emissions|CO2|Energy|Demand|Transportation|Rail|Freight Emissions|CO2|Energy|Demand|Transportation|Rail|Freight
│││ │╰Emissions|CO2|Energy|Demand|Transportation|Rail|Passenger Emissions|CO2|Energy|Demand|Transportation|Rail|Passenger
│││ ╰Emissions|CO2|Energy|Demand|Transportation|Road Emissions|CO2|Energy|Demand|Transportation|Road
│││  ├Emissions|CO2|Energy|Demand|Transportation|Road|Freight Emissions|CO2|Energy|Demand|Transportation|Road|Freight
│││  ╰Emissions|CO2|Energy|Demand|Transportation|Road|Passenger Emissions|CO2|Energy|Demand|Transportation|Road|Passenger
│││   ├Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|2W&3W Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|2W&3W
│││   ├Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|Bus Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|Bus
│││   ╰Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|LDV Emissions|CO2|Energy|Demand|Transportation|Road|Passenger|LDV
││╰Emissions|CO2|Energy|Supply Emissions|CO2|Energy|Supply
││ ├Emissions|CO2|Energy|Supply|Electricity Emissions|CO2|Energy|Supply|Electricity
││ ├Emissions|CO2|Energy|Supply|Gases Emissions|CO2|Energy|Supply|Gases
││ ├Emissions|CO2|Energy|Supply|Heat Emissions|CO2|Energy|Supply|Heat
││ ├Emissions|CO2|Energy|Supply|Liquids Emissions|CO2|Energy|Supply|Liquids
││ ├Emissions|CO2|Energy|Supply|Other Sector Emissions|CO2|Energy|Supply|Other Sector
││ ╰Emissions|CO2|Energy|Supply|Solids Emissions|CO2|Energy|Supply|Solids
│├Emissions|CO2|Energy and Industrial Processes Emissions|CO2|Energy and Industrial Processes
│├Emissions|CO2|Industrial Processes Emissions|CO2|Industrial Processes
││├Emissions|CO2|Industrial Processes|Cement Emissions|CO2|Industrial Processes|Cement
││├Emissions|CO2|Industrial Processes|Chemicals Emissions|CO2|Industrial Processes|Chemicals
│││├Emissions|CO2|Industrial Processes|Chemicals|Ammonia Emissions|CO2|Industrial Processes|Chemicals|Ammonia
│││├Emissions|CO2|Industrial Processes|Chemicals|High value chemicals Emissions|CO2|Industrial Processes|Chemicals|High value chemicals
│││├Emissions|CO2|Industrial Processes|Chemicals|Methanol Emissions|CO2|Industrial Processes|Chemicals|Methanol
│││╰Emissions|CO2|Industrial Processes|Chemicals|Other Emissions|CO2|Industrial Processes|Chemicals|Other
││├Emissions|CO2|Industrial Processes|Non-ferrous metals Emissions|CO2|Industrial Processes|Non-ferrous metals
││├Emissions|CO2|Industrial Processes|Other Emissions|CO2|Industrial Processes|Other
││├Emissions|CO2|Industrial Processes|Pulp and Paper Emissions|CO2|Industrial Processes|Pulp and Paper
││╰Emissions|CO2|Industrial Processes|Steel Emissions|CO2|Industrial Processes|Steel
│├Emissions|CO2|Other Emissions|CO2|Other
│╰Emissions|CO2|Waste Emissions|CO2|Waste
├Emissions|CO Emissions|CO
│├Emissions|CO|AFOLU Emissions|CO|AFOLU
││├Emissions|CO|AFOLU|Agriculture Emissions|CO|AFOLU|Agriculture
││╰Emissions|CO|AFOLU|Land Emissions|CO|AFOLU|Land
│├Emissions|CO|Energy Emissions|CO|Energy
││╰Emissions|CO|Energy|Supply Emissions|CO|Energy|Supply
│├Emissions|CO|Industrial Processes Emissions|CO|Industrial Processes
│├Emissions|CO|Other Emissions|CO|Other
│╰Emissions|CO|Waste Emissions|CO|Waste
├Emissions|F-Gases Emissions|F-Gases
├Emissions|HFC Emissions|HFC
│├Emissions|HFC|HFC23 Emissions|HFC|HFC23
│├Emissions|HFC|HFC32 Emissions|HFC|HFC32
│├Emissions|HFC|HFC43-10 Emissions|HFC|HFC43-10
│├Emissions|HFC|HFC125 Emissions|HFC|HFC125
│├Emissions|HFC|HFC134a Emissions|HFC|HFC134a
│├Emissions|HFC|HFC143a Emissions|HFC|HFC143a
│├Emissions|HFC|HFC227ea Emissions|HFC|HFC227ea
│├Emissions|HFC|HFC245fa Emissions|HFC|HFC245fa
│╰Emissions|HFC|Industrial Processes Emissions|HFC|Industrial Processes
├Emissions|Kyoto Gases Emissions|Kyoto Gases
├Emissions|N2O Emissions|N2O
│├Emissions|N2O|AFOLU Emissions|N2O|AFOLU
││├Emissions|N2O|AFOLU|Agriculture Emissions|N2O|AFOLU|Agriculture
│││╰Emissions|N2O|AFOLU|Agriculture|Managed Soils Emissions|N2O|AFOLU|Agriculture|Managed Soils
││╰Emissions|N2O|AFOLU|Land Emissions|N2O|AFOLU|Land
│├Emissions|N2O|Energy Emissions|N2O|Energy
│├Emissions|N2O|Industrial Processes Emissions|N2O|Industrial Processes
││╰Emissions|N2O|Industrial Processes|Chemicals Emissions|N2O|Industrial Processes|Chemicals
│├Emissions|N2O|Other Emissions|N2O|Other
│╰Emissions|N2O|Waste Emissions|N2O|Waste
├Emissions|NH3 Emissions|NH3
│├Emissions|NH3|AFOLU Emissions|NH3|AFOLU
││├Emissions|NH3|AFOLU|Agriculture Emissions|NH3|AFOLU|Agriculture
││╰Emissions|NH3|AFOLU|Land Emissions|NH3|AFOLU|Land
│├Emissions|NH3|Energy Emissions|NH3|Energy
││╰Emissions|NH3|Energy|Supply Emissions|NH3|Energy|Supply
│├Emissions|NH3|Industrial Processes Emissions|NH3|Industrial Processes
│├Emissions|NH3|Other Emissions|NH3|Other
│╰Emissions|NH3|Waste Emissions|NH3|Waste
├Emissions|NOx Emissions|NOx
│├Emissions|NOx|AFOLU Emissions|NOx|AFOLU
││├Emissions|NOx|AFOLU|Agriculture Emissions|NOx|AFOLU|Agriculture
││╰Emissions|NOx|AFOLU|Land Emissions|NOx|AFOLU|Land
│├Emissions|NOx|Energy Emissions|NOx|Energy
││╰Emissions|NOx|Energy|Supply Emissions|NOx|Energy|Supply
│├Emissions|NOx|Industrial Processes Emissions|NOx|Industrial Processes
│├Emissions|NOx|Other Emissions|NOx|Other
│╰Emissions|NOx|Waste Emissions|NOx|Waste
├Emissions|OC Emissions|OC
│├Emissions|OC|AFOLU Emissions|OC|AFOLU
││├Emissions|OC|AFOLU|Agriculture Emissions|OC|AFOLU|Agriculture
││╰Emissions|OC|AFOLU|Land Emissions|OC|AFOLU|Land
│├Emissions|OC|Energy Emissions|OC|Energy
││╰Emissions|OC|Energy|Supply Emissions|OC|Energy|Supply
│├Emissions|OC|Industrial Processes Emissions|OC|Industrial Processes
│├Emissions|OC|Other Emissions|OC|Other
│╰Emissions|OC|Waste Emissions|OC|Waste
├Emissions|PFC Emissions|PFC
│├Emissions|PFC|C2F6 Emissions|PFC|C2F6
│├Emissions|PFC|C6F14 Emissions|PFC|C6F14
│╰Emissions|PFC|CF4 Emissions|PFC|CF4
├Emissions|PM2.5 Emissions|PM2.5
├Emissions|SF6 Emissions|SF6
├Emissions|Sulfur Emissions|Sulfur
│├Emissions|Sulfur|AFOLU Emissions|Sulfur|AFOLU
││├Emissions|Sulfur|AFOLU|Agriculture Emissions|Sulfur|AFOLU|Agriculture
││╰Emissions|Sulfur|AFOLU|Land Emissions|Sulfur|AFOLU|Land
│├Emissions|Sulfur|Energy Emissions|Sulfur|Energy
││╰Emissions|Sulfur|Energy|Supply Emissions|Sulfur|Energy|Supply
│├Emissions|Sulfur|Industrial Processes Emissions|Sulfur|Industrial Processes
│├Emissions|Sulfur|Other Emissions|Sulfur|Other
│╰Emissions|Sulfur|Waste Emissions|Sulfur|Waste
╰Emissions|VOC Emissions|VOC
 ├Emissions|VOC|AFOLU Emissions|VOC|AFOLU
 │├Emissions|VOC|AFOLU|Agriculture Emissions|VOC|AFOLU|Agriculture
 │╰Emissions|VOC|AFOLU|Land Emissions|VOC|AFOLU|Land
 ├Emissions|VOC|Energy Emissions|VOC|Energy
 │╰Emissions|VOC|Energy|Supply Emissions|VOC|Energy|Supply
 ├Emissions|VOC|Industrial Processes Emissions|VOC|Industrial Processes
 ├Emissions|VOC|Other Emissions|VOC|Other
 ╰Emissions|VOC|Waste Emissions|VOC|Waste

@rgieseke
Copy link
Contributor Author

rgieseke commented Apr 8, 2022

Also not sure how to deal with top-level categories which do not exist as variables in the DB, e.g. 'Price'

Price 
╰Price|Carbon

Only Price|Carbon is there.

For variables like Emissions it makes sense to have them grouped of course.

@mikapfl
Copy link
Member

mikapfl commented Apr 8, 2022

Cool stuff!

Having Prices grouped if there are multiple prices makes sense, I think. That's of course a deviation from the original definition, but it is a strict extension and unlikely to lead to problems in future updates of the categorization. We have precedents for that, the 0 category for a total doesn't actually exist in the IPCC* categorizations, we added it anyway since it is so widely used and a straightforward extension.

Due to being at a conference, I won't be able to look into this further before Easter, I fear.

Cheers,

Mika

@rgieseke
Copy link
Contributor Author

rgieseke commented Apr 8, 2022

No worries, enjoy the conference and your holidays!

As for the top-level category I didn't really add a new category, but only extracted the top-level one, so there are no Emissions in the DB, but i am interested in being able to get all the Emissions categories (and even might aggregate them using GWPs).

@rgieseke
Copy link
Contributor Author

rgieseke commented Apr 8, 2022

Also need to check whether these are hierarchical (doesn't really look like it):

Primary Energy:
    title: Primary Energy
    info:
      unit: EJ/yr
    children:
    - - Primary Energy|Biomass
      - Primary Energy|Coal
      - Primary Energy|Fossil
      - Primary Energy|Gas
      - Primary Energy|Geothermal
      - Primary Energy|Hydro
      - Primary Energy|Non-Biomass Renewables
      - Primary Energy|Nuclear
      - Primary Energy|Ocean
      - Primary Energy|Oil
      - Primary Energy|Other
      - Primary Energy|Renewables (incl. Biomass)
      - Primary Energy|Secondary Energy Trade
      - Primary Energy|Solar
      - Primary Energy|Wind

@mikapfl
Copy link
Member

mikapfl commented Apr 11, 2022

Also need to check whether these are hierarchical (doesn't really look like it):

They are definitely not total_sum.

@mikapfl
Copy link
Member

mikapfl commented May 10, 2023

Looks good, if it is ready from your side, I could add the necessary documentation in README etc. and merge.

@rgieseke
Copy link
Contributor Author

I don't think I looked through the questions above.
Would probably good to look through this with someone who understands the scenarios categories well.

@mikapfl
Copy link
Member

mikapfl commented May 10, 2023

I think it is pretty clear that the categorization is hierarchical, but not total_sum (it is hierarchical iff parent-child relationships exist, and it is total_sum iff the sum of sets of children equals the parent if a sum is defined). Also, generating top-level categories which are not in the database is fine. Are there other remaining questions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants