Add region definitions and mappings for REMIND 3.3

.github/workflows/validation.yml

@@ -23,7 +23,7 @@ jobs:
         python-version: 3.11
 
     - name: Install dependencies
-      run: pip install nomenclature-iamc>=0.12.0
+      run: pip install -e .
 
     - name: Run the nomenclature project validation
       run: nomenclature validate-project . --dimension region --dimension variable

definitions/region/model_native_regions/REMIND_3.3.yaml

@@ -0,0 +1,62 @@
+- REMIND 3.3:
+  - REMIND 3.3|Canada, Australia, New Zealand:
+      iso3_codes: [AUS, CAN, HMD, NZL, SPM]
+  - REMIND 3.3|China and Taiwan:
+      iso3_codes: [CHN, HKG, MAC, TWN]
+  - REMIND 3.3|India:
+      iso3_codes: IND
+  - REMIND 3.3|Japan:
+      iso3_codes: JPN
+  - REMIND 3.3|Other Asia:
+      iso3_codes: [AFG, ASM, ATF, BGD, BRN, BTN, CCK, COK, CXR, FJI, FSM, GUM, IDN,
+        IOT, KHM, KIR, KOR, LAO, LKA, MDV, MHL, MMR, MNG, MNP, MYS, NCL, NFK, NIU,
+        NPL, NRU, PAK, PCN, PHL, PLW, PNG, PRK, PYF, SGP, SLB, TKL, TLS, TON, THA,
+        TUV, UMI, VNM, VUT, WLF, WSM]
+  - REMIND 3.3|Latin America and the Caribbean:
+      iso3_codes: [ABW, AIA, ARG, ATA, ATG, BES, BHS, BLM, BLZ, BMU, BOL, BRA, BRB,
+        BVT, CHL, COL, CRI, CUB, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY,
+        HND, HTI, JAM, KNA, LCA, MAF, MEX, MSR, MTQ, NIC, PAN, PER, PRI, PRY, SGS,
+        SLV, SUR, TTO, URY, VCT, VEN, VGB, VIR, BES, CUW, SXM, TCA]
+  - REMIND 3.3|Middle East and North Africa:
+      iso3_codes: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR,
+        OMN, PSE, QAT, SAU, SDN, TUN, YEM, SYR]
+  - REMIND 3.3|Russia and Reforming Economies:
+      iso3_codes: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TKM, UKR, UZB, TJK]
+  - REMIND 3.3|Sub-Saharan Africa:
+      iso3_codes: [AGO, BDI, BEN, BFA, BWA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI,
+        ERI, ETH, GAB, GHA, GIN, GMB, GNB, GNQ, KEN, LBR, LSO, MDG, MLI, MOZ, MRT,
+        MUS, MWI, MYT, NAM, NER, NGA, REU, RWA, SEN, SHN, SLE, SOM, SSD, STP, SWZ,
+        SYC, TGO, TZA, UGA, ZAF, ZMB, ZWE, TCD]
+  - REMIND 3.3|United States:
+      iso3_codes: USA
+# 12-region version of REMIND
+  - REMIND 3.3|EU 28:
+      iso3_codes: [ALA, AUT, BEL, BGR, CYP, CZE, DNK, ESP, EST, FIN, FRO, GGY, GIB,
+        GRC, HRV, HUN, IMN, IRL, ITA, JEY, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROU,
+        SVK, SVN, SWE, FRA, DEU, ITA, GIB, GGY, GBR]
+  - REMIND 3.3|Non-EU28 Europe:
+      iso3_codes: [ALB, AND, BIH, CHE, GRL, ISL, LIE, MCO, MKD, MNE, NOR, SJM, SMR,
+        SRB, TUR, VAT]
+# 21-region version of REMIND
+  - REMIND 3.3|Germany:
+      iso3_codes: DEU
+  - REMIND 3.3|France:
+      iso3_codes: FRA
+  - REMIND 3.3|United Kingdom and Ireland:
+      iso3_codes: [GIB, GGY, IRL, IMN, JEY, GBR]
+  - REMIND 3.3|EU Center-East Europe:
+      iso3_codes: [CZE, EST, LVA, LTU, POL, SVK]
+  - REMIND 3.3|EU Center-South Europe:
+      iso3_codes: [BGR, HRV, HUN, ROU, SVN]
+  - REMIND 3.3|EU North-Center Europe:
+      iso3_codes: [ALA, DNK, FRO, FIN, SWE]
+  - REMIND 3.3|EU South-Center Europe:
+      iso3_codes: [CYP, GRC, ITA, MLT]
+  - REMIND 3.3|EU South-West Europe:
+      iso3_codes: [PRT, ESP]
+  - REMIND 3.3|EU North-West Europe:
+      iso3_codes: [AUT, BEL, LUX, NLD]
+  - REMIND 3.3|Non-EU Northern Europe:
+      iso3_codes: [ISL, LIE, NOR, SJM, CHE, GRL]
+  - REMIND 3.3|Non-EU Southern Europe:
+      iso3_codes: [ALB, AND, BIH, VAT, MKD, MCO, MNE, SMR, SRB, TUR]

mappings/REMIND_3.3.yml

@@ -0,0 +1,148 @@
+model:
+  - REMIND 3.3
+native_regions:
+  - CAZ: REMIND 3.3|Canada, Australia, New Zealand
+  - CHA: REMIND 3.3|China and Taiwan
+  - IND: REMIND 3.3|India
+  - JPN: REMIND 3.3|Japan
+  - OAS: REMIND 3.3|Other Asia
+  - LAM: REMIND 3.3|Latin America and the Caribbean
+  - MEA: REMIND 3.3|Middle East and North Africa
+  - REF: REMIND 3.3|Russia and Reforming Economies
+  - SSA: REMIND 3.3|Sub-Saharan Africa
+  - USA: REMIND 3.3|United States
+    # 12-region version of REMIND
+  - EUR: REMIND 3.3|EU 28
+  - NEU: REMIND 3.3|Non-EU28 Europe
+  # 21-region version of REMIND
+  - DEU: REMIND 3.3|Germany
+  - FRA: REMIND 3.3|France
+  - UKI: REMIND 3.3|United Kingdom and Ireland
+  - ECE: REMIND 3.3|EU Center-East Europe
+  - ECS: REMIND 3.3|EU Center-South Europe
+  - ENC: REMIND 3.3|EU North-Center Europe
+  - ESC: REMIND 3.3|EU South-Center Europe
+  - ESW: REMIND 3.3|EU South-West Europe
+  - EWN: REMIND 3.3|EU North-West Europe
+  - NEN: REMIND 3.3|Non-EU Northern Europe
+  - NES: REMIND 3.3|Non-EU Southern Europe
+# exogenously aggregated regions that should appear with the same name as uploaded in the IIASA database
+  - EU27
+
+common_regions:
+  - World:
+    - CAZ
+    - CHA
+    - IND
+    - JPN
+    - OAS
+    - LAM
+    - MEA
+    - REF
+    - SSA
+    - USA
+    # 12-region version of REMIND
+    - EUR
+    - NEU
+    # 21-region version of REMIND
+    - DEU
+    - FRA
+    - UKI
+    - ECE
+    - ECS
+    - ENC
+    - ESC
+    - ESW
+    - EWN
+    - NEN
+    - NES
+
+# aggregations used in the ECEMF project
+  - EU27 & UK:
+    # 12-region version of REMIND
+    - EUR
+    # 21-region version of REMIND
+    - DEU
+    - FRA
+    - UKI
+    - ECE
+    - ECS
+    - ENC
+    - ESC
+    - ESW
+    - EWN
+  - EU27 & UK (*):
+    # 12-region version of REMIND
+    - EUR
+    # 21-region version of REMIND
+    - DEU
+    - FRA
+    - UKI
+    - ECE
+    - ECS
+    - ENC
+    - ESC
+    - ESW
+    - EWN
+  - EU27 (*):
+    - EU27
+  - Germany:
+    - DEU
+  - France:
+    - FRA
+
+# R5 regions
+  - Asia (R5):
+    - CHA
+    - IND
+    - OAS
+  - Latin America (R5):
+    - LAM
+  - Middle East & Africa (R5):
+    - SSA
+    - MEA
+  - OECD & EU (R5):
+    - JPN
+    - USA
+    - CAZ
+    # 12-region version of REMIND
+    - EUR
+    - NEU
+    # 21-region version of REMIND
+    - DEU
+    - FRA
+    - UKI
+    - ECE
+    - ENC
+    - ECS
+    - ESC
+    - ESW
+    - EWN
+    - NEN
+    - NES
+  - Reforming Economies (R5):
+    - REF
+
+# Innopaths regions
+  - Germany (IP):
+    - DEU
+  - Eastern Europe (IP):
+    - ECE
+  - Scandinavia (IP):
+    - ENC
+  - South-East Europe (IP):
+    - ECS
+  - Southern Europe (IP):
+    - ESC
+  - Iberian Peninsula (IP):
+    - ESW
+  - Central Europe (IP):
+    - EWN
+  - France (IP):
+    - FRA
+  - United Kingdom & Ireland (IP):
+    - UKI
+  - Northern non-EU Europe (IP):
+    - NEN
+  - Southern non-EU Europe (IP):
+    - NES

setup.cfg

@@ -13,7 +13,7 @@ packages = openentrance
 install_requires =
     setuptools >= 41
     pyyaml
-    nomenclature-iamc >= 0.16.0
+    nomenclature-iamc >= 0.16.0, < 0.17.0
     iam-units >= 2021.11.12
 setup_requires =
     setuptools >= 41