Add "iea-eweb-product" annos to the "commodity" codelist

Author: khaeru

doc/api/data-sources.rst

@@ -51,7 +51,7 @@ Structure
 
 The data have the following conceptual dimensions, each enumerated by a different list of codes:
 
-- ``FLOW`, ``PRODUCT``: for both of these, the lists of codes appearing in the data are the same from 2021 and 2023 inclusive.
+- ``FLOW``, ``PRODUCT``: for both of these, the lists of codes appearing in the data are the same from 2021 and 2023 inclusive.
 - ``COUNTRY``: The data provided by IEA directly contain codes that are all caps, abbreviated country names, for instance "DOMINICANR".
   The data provided by the OECD contain ISO 3166-1 alpha-3 codes, for instance "DOM".
   In both cases, there are additional labels denoting country groupings; these are defined in the documentation linked above.

doc/pkg-data/codelists.rst

@@ -1,6 +1,8 @@
 Other code lists
 ****************
 
+These codelists correspond to :doc:`sets in the generic MESSAGE IAM formulation <message-ix:model/MESSAGE/sets_maps_def>` with the same names.
+
 .. contents::
    :local:
 
@@ -9,12 +11,14 @@ Other code lists
 Commodities (``commodity.yaml``)
 ================================
 
-Each of these codes has the following annotations:
+These codes hav the following annotations:
 
-``level``
+``level`` (mandatory)
    Level where this commodity typically (not exclusively) occurs.
-``unit``
+``units`` (mandatory)
    Units typically associated with this commodity.
+``iea-eweb-product`` (optional)
+   List of ``PRODUCT`` codes from the IEA :ref:`tools-iea-web` associated with this MESSAGEix-GLOBIOM commodity.
 
 .. literalinclude:: ../../message_ix_models/data/commodity.yaml
    :language: yaml

message_ix_models/data/commodity.yaml

@@ -12,6 +12,26 @@ coal:
   #    term usually refers to anthracite, which has a higher
   #    carbon emission factor.
   ipcc-1996-name: "Other Bituminous Coal"
+  iea-eweb-product:
+  - ANTCOAL
+  - BITCOAL
+  - BKB
+  - BLFURGS
+  - BROWN
+  - COALTAR
+  - COKCOAL
+  - COKEOVGS
+  - GASCOKE
+  - GASWKSGS
+  - HARDCOAL
+  - INDWASTE
+  - LIGNITE
+  - MANGAS
+  - MUNWASTEN
+  - OVENCOKE
+  - PATFUEL
+  - PEAT
+  - SUBCOAL
 
 crudeoil:
   name: Crude oil
@@ -32,11 +52,13 @@ electr:
   name: Electricity
   units: GWa
   report: Electricity
+  iea-eweb-product: [ELECTR]
 
 ethanol:
   name: Ethanol
   units: GWa
   report: Liquids|Biomass
+  iea-eweb-product: [BIODIESEL, BIOGASOL, BIOJETKERO, OBIOLIQ]
 
 freshwater_supply:
   name: (?) Fresh water
@@ -49,12 +71,14 @@ fueloil:
   level: secondary
   units: GWa
   ipcc-1996-name: "Residual Fuel Oil"
+  iea-eweb-product: [BITUMEN, PARWAX, PETCOKE, RESFUEL]
 
 gas:
   name: Natural Gas
   units: GWa
   report: Gases
   ipcc-1996-name: "Natural Gas (Dry)"
+  iea-eweb-product: [NATGAS]
 
 hydrogen:
   name: Gaseous hydrogen
@@ -72,6 +96,20 @@ lightoil:
   report: Liquids|Oil
   # NB same value as "Crude Oil" and several others; this choice is arbitrary
   ipcc-1996-name: "Other Oil"
+  iea-eweb-product:
+  - AVGAS
+  - ETHANE
+  - JETGAS
+  - LPG
+  - LUBRIC
+  - NAPHTHA
+  - NONBIODIES
+  - NONBIOGASO
+  - NONBIOJETK
+  - ONONSPEC
+  - OTHKERO
+  - REFINGAS
+  - WHITESP
 
 lignite:
   name: Lignite