Node code lists

The codes in these lists denote regions and countries.

When loaded using get_codes(), the Code.child attribute is a list of child codes. See the function documentation for how to retrieve these.

Models with global scope

32-region aggregation (R32)

World:
  name: World
  description: |-
    Region code list for the SSP 32-region aggregation.

    Source: https://tntcat.iiasa.ac.at/SspDb/dsd?Action=htmlpage&page=about

R32ANUZ:
  parent: World
  name: Australia & New Zealand
  description: This region includes Australia and New Zealand.
  child: [AUS, NZL]

R32BRA:
  parent: World
  name: Brazil
  child: [BRA]

R32CAN:
  parent: World
  name: Canada
  child: [CAN]

R32CAS:
  parent: World
  name: Central Asia
  description: This region includes the countries of Central Asia.
  child: [ARM, AZE, GEO, KAZ, KGZ, TJK, TKM, UZB]

R32CHN:
  parent: World
  name: China excl. Taiwan
  description: China (Mainland, Hongkong, Macao; excl. Taiwan).
  child: [CHN, HKG, MAC]

R32EEU:
  parent: World
  name: Eastern Europe
  description: |-
    Eastern Europe (excl. former Soviet Union and EU member states).

    The source page describes “the former Yugoslav Republic of Macedonia”; this entity was renamed in 2018 to “North Macedonia”.
  child: [ALB, BIH, HRV, MKD, MNE, SRB]

R32EEU-FSU:
  parent: World
  name: Former Soviet Union in Eastern Europe
  description: Eastern Europe, former Soviet Union (excl. Russia and EU members).
  child: [BLR, MDA, UKR]

R32EFTA:
  parent: World
  name: European Free Trade Association
  description: |-
    This region includes Iceland, Norway, Switzerland.

    The source omits Liechtenstein, but it is included as a child.
  child: [ISL, LIE, NOR, CHE]

R32EU12-H:
  parent: World
  name: EU member states new in 2004, high income
  description: New EU member states that joined as of 2004 - high income.
  child: [CYP, CZE, EST, HUN, MLT, POL, SVK, SVN]

R32EU12-M:
  parent: World
  name: EU member states new in 2004, middle income
  description: New EU member states that joined as of 2004 - medium income.
  child: [BGR, LTU, LVA, ROU]

R32EU15:
  parent: World
  name: EU member states pre-2004
  description: This region includes European Union member states that joined prior to 2004.
  child: [AUT, BEL, DEU, DNK, ESP, FIN, FRA, GBR, GRC, IRL, ITA, LUX, NLD, PRT, SWE]

R32IDN:
  parent: World
  name: Indonesia
  child: [IDN]

R32IND:
  parent: World
  name: India
  child: [IND]

R32JPN:
  parent: World
  name: Japan
  child: [JPN]

R32KOR:
  parent: World
  name: Republic of Korea
  child: [KOR]

R32LAM-L:
  parent: World
  name: Latin America, low income
  description: This region includes the countries of Latin America (excl. Brazil, Mexico) - low income.
  child: [BLZ, GTM, HND, HTI, NIC]

R32LAM-M:
  parent: World
  name: Latin America, middle & high income
  description: |-
    This region includes the countries of Latin America (excl. Brazil, Mexico) - medium and high income.

    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT), but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, BES, BHS, BMU, BOL, BRB, CHL, COL, CRI, CUB, CUW, DMA, DOM, ECU, GLP, GRD, GUF, GUY, JAM, KNA, LCA, PAN, PER, PRY, MTQ, SLV, SUR, SXM, TTO, URY, VCT, VEN]

R32MEA-H:
  parent: World
  name: Middle East & Asia, high income
  description: This region includes the countries of Middle East Asia - high income.
  child: [ARE, BHR, ISR, KWT, OMN, QAT, SAU]

R32MEA-M:
  parent: World
  name: Middle East & Asia, low & middle income
  description: This region includes the countries of Middle East Asia - low and medium income.
  child: [IRN, IRQ, JOR, LBN, PSE, SYR, YEM]

R32MEX:
  parent: World
  name: Mexico
  child: [MEX]

R32NAF:
  parent: World
  name: North Africa
  description: This region includes the countries of North Africa.
  child: [DZA, EGY, ESH, LBY, MAR, TUN]

R32OAS-CPA:
  parent: World
  name: Other Asia
  description: This region includes the countries of Other Asia - former Centrally Planned Asia.
  child: [KHM, LAO, MNG, VNM]

R32OAS-L:
  parent: World
  name: Other Asia, low income
  description: This region includes the countries of Other Asia - low income.
  child: [BGD, FJI, FSM, MMR, NPL, PHL, PNG, PRK, SLB, TLS, TON, VUT, WSM]

R32OAS-M:
  parent: World
  name: Other Asia, middle & high income
  description: This region includes the countries of Other Asia - medium and high income.
  child: [BRN, BTN, GUM, LKA, MDV, MYS, NCL, PYF, SGP, THA]

R32PAK:
  parent: World
  name: Pakistan & Afghanistan
  description: This region includes Pakistan and Afghanistan.
  child: [AFG, PAK]

R32RUS:
  parent: World
  name: Russian Federation
  child: [RUS]

R32SAF:
  parent: World
  name: South Africa
  child: [ZAF]

R32SSA-L:
  parent: World
  name: Sub-Saharan Africa, low income
  description: This region includes the countries of Subsahara Africa (excl. South Africa) - low income.
  child: [BDI, BEN, BFA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI, ERI, ETH, GHA, GIN, GMB, GNB, KEN, LBR, LSO, MDG, MLI, MOZ, MRT, MWI, NER, NGA, RWA, SDN, SEN, SLE, SOM, SSD, STP, SWZ, TCD, TGO, TZA, UGA, ZMB, ZWE]

R32SSA-M:
  parent: World
  name: Sub-Saharan Africa, middle & high income
  description: This region includes the countries of Subsahara Africa (excl. South Africa) - medium and high income.
  child: [AGO, BWA, GAB, GNQ, MUS, MYT, NAM, REU, SYC]

R32TUR:
  parent: World
  name: Turkey
  child: [TUR]

R32TWN:
  parent: World
  name: Taiwan
  child: [TWN]

R32USA:
  parent: World
  name: United States of America
  description: United States of America.
  child: [PRI, USA, VIR]

20-region aggregation (R20)

# Region code list
#
# - See message_data.tools.regions.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia

World:
  name: World
  description: R20 regions

R20_AFR:
  parent: World
  name: Sub-Saharan Africa
  child: [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, STP, SWZ, SYC, TCD, TGO, TZA, UGA, ZAF, ZMB, ZWE]
  iea-weo-region: Africa

R20_CHN:
  parent: World
  name: China
  child: [CHN, HKG]
  iea-weo-region: China

R20_PRK:
  parent: World
  name: North Korea
  child: [PRK]
  iea-weo-region: Russia

R20_MNG:
  parent: World
  name: Mongolia
  child: [MNG]
  iea-weo-region: Russia

R20_MSA:
  parent: World
  name: Mainland Southeast Asia
  child: [KHM, LAO, VNM]
  iea-weo-region: India

R20_JPN:
  parent: World
  name: Japan
  child: [JPN]
  iea-weo-region: Japan

R20_AUNZ:
  parent: World
  name: Australia and New Zealand
  child: [AUS, NZL]
  iea-weo-region: Japan

R20_KOR:
  parent: World
  name: South Korea
  child: [KOR]
  iea-weo-region: China

R20_SEA:
  parent: World
  name: South East Asia
  description: >-
    Trust Territory of the Pacific Islands (PCI) still included in this list,
    but it was dissolved into MHL, FSM, MNP and PLW in 1986.
  child: [ASM, BRN, CCK, COK, CXR, FJI, FSM, IDN, KIR, MAC, MHL, MMR, MNP, MYS, NCL, NFK, NIU, NRU, PCI, PCN, PHL, PLW, PNG, PYF, SGP, SLB, THA, TKL, TLS, TON, TUV, TWN, VUT, WLF, WSM]
  iea-weo-region: India

R20_RUBY:
  parent: World
  name: Russia and Belarus
  child: [RUS, BLR]
  iea-weo-region: Russia

R20_UMBA:
  parent: World
  name: Ukraine, Moldova and Balkans
  description: >-
    Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list,
    even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, BGR, BIH, MDA, MKD, MNE, SCG, SRB, UKR, YUG, XKO]
  iea-weo-region: Russia

R20_CAS:
  parent: World
  name: Centra Asia
  child: [ KAZ, KGZ, TJK, TKM, UZB]
  iea-weo-region: Russia

R20_SCST:
  parent: World
  name: South Caucasus and Turkey
  child: [ARM, AZE,  GEO,  TUR]
  iea-weo-region: European Union

R20_EEU27:
  parent: World
  name: Central and Eastern Europe (EU27)
  child: [CZE, EST, HRV, HUN, LTU, LVA, POL, ROU, SVK, SVN]
  iea-weo-region: European Union

R20_LAM:
  parent: World
  name: Latin America and The Caribbean
  description: >-
    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT),
    but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRY, SLV, SUR, SXM, TCA, TTO, URY, VCT, VEN, VGB]
  iea-weo-region: Brazil

R20_MEA:
  parent: World
  name: Middle East and North Africa
  child: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR, OMN, PSE, QAT, SAU, SDN, SSD, SYR, TUN, YEM]
  iea-weo-region: Middle East

R20_NAM:
  parent: World
  name: North America
  child: [CAN, GUM, PRI, SPM, USA, VIR]
  iea-weo-region: United States

R20_SAS:
  parent: World
  name: South Asia
  child: [AFG, BGD, BTN, IND, LKA, MDV, NPL, PAK]
  iea-weo-region: India

R20_WEU27:
  parent: World
  name: Western Europe (EU27)
  child: [AND, AUT, BEL, CYP, DEU, DNK, ESP, FIN, FRA, FRO, GIB, GRC, GRL, IMN, IRL, ITA, LUX, MCO, MLT, NLD, PRT, SJM, SMR, SWE, VAT]
  iea-weo-region: European Union

R20_UKEFT:
  parent: World
  name: UK and European Free Trade Association
  child: [GBR, ISL, CHE, NOR, LIE]
  iea-weo-region: European Union

17-region aggregation (R17)

# Region code list
#
# - See message_data.tools.regions.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia

World:
  name: World
  description: R20 regions

R17_AFR:
  parent: World
  name: Sub-Saharan Africa
  child: [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, STP, SWZ, SYC, TCD, TGO, TZA, UGA, ZAF, ZMB, ZWE]

R17_CHN:
  parent: World
  name: China
  child: [CHN, HKG]

R17_PRK:
  parent: World
  name: North Korea
  child: [PRK]

R17_MNG:
  parent: World
  name: Mangolia
  child: [MNG]

R17_RCPA:
  parent: World
  name: East Asia
  child: [KHM, LAO, VNM]

R17_JAP:
  parent: World
  name: Japan
  child: [JPN]

R17_RPAO:
  parent: World
  name: Pacific OECD
  child: [AUS, NZL]

R17_KOR:
  parent: World
  name: South Korea
  child: [KOR]

R17_RPAS:
  parent: World
  name: Pacific Asia
  description: >-
    Trust Territory of the Pacific Islands (PCI) still included in this list,
    but it was dissolved into MHL, FSM, MNP and PLW in 1986.
  child: [ASM, BRN, CCK, COK, CXR, FJI, FSM, IDN, KIR, MAC, MHL, MMR, MNP, MYS, NCL, NFK, NIU, NRU, PCI, PCN, PHL, PLW, PNG, PYF, SGP, SLB, THA, TKL, TLS, TON, TUV, TWN, VUT, WLF, WSM]

R17_RFSU:
  parent: World
  name: Former Soviet Union
  child: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, TJK, TKM, UKR, UZB]

R17_RUS:
  parent: World
  name: Russia
  child: [RUS]

R17_LAM:
  parent: World
  name: Latin America and The Caribbean
  description: >-
   The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT),
    but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRY, SLV, SUR, SXM, TCA, TTO, URY, VCT, VEN, VGB]

R17_MEA:
  parent: World
  name: Middle East and North Africa
  child: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR, OMN, PSE, QAT, SAU, SDN, SSD, SYR, TUN, YEM]

R17_NAM:
  parent: World
  name: North America
  child: [CAN, GUM, PRI, SPM, USA, VIR]

R17_SAS:
  parent: World
  name: South Asia
  child: [AFG, BGD, BTN, IND, LKA, MDV, NPL, PAK]

R17_WEU:
  parent: World
  name: Western Europe
  child: [AND, AUT, BEL, CHE, CYP, DEU, DNK, ESP, FIN, FRA, FRO, GBR, GIB, GRC, GRL, IMN, IRL, ISL, ITA, LIE, LUX, MCO, MLT, NLD, NOR, PRT, SJM, SMR, SWE, TUR, VAT]

R17_EEU:
  parent: World
  name: Central and Eastern Europe
  description: >-
   Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list,
    even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, BGR, BIH, CZE, EST, HRV, HUN, LTU, LVA, MKD, MNE, POL, ROU, SCG, SRB, SVK, SVN, YUG]

14-region aggregation (R14)

# Region code list
#
# - See message_data.tools.regions.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia

World:
  name: World
  description: R14 regions

R14_AFR:
  parent: World
  name: Sub-Saharan Africa
  child: [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, SDN, SEN, SHN, SLE, SOM, STP, SWZ, SYC, TCD, TGO, TZA, UGA, ZAF, ZMB, ZWE]

R14_CAS:
  parent: World
  name: Central Asia
  child: [KAZ, KGZ, TJK, TKM, UZB]

R14_CPA:
  parent: World
  name: Centrally Planned Asia
  child: [CHN, KHM, LAO, MAC, MNG, PRK, TWN, VNM]

R14_EEU:
  parent: World
  name: Central and Eastern Europe
  description: >-
    Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list,
    even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, BGR, BIH, CZE, EST, HRV, HUN, LTU, LVA, MKD, MNE, POL, ROU, SCG, SRB, SVK, SVN, YUG]

R14_LAM:
  parent: World
  name: Latin America and The Caribbean
  description: >-
    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT),
    but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRI, PRY, SLV, SUR, SXM, TCA, TTO, URY, VCT, VEN, VGB]

R14_MEA:
  parent: World
  name: Middle East and North Africa
  child: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR, OMN, PSE, QAT, SAU, SDN, SSD, SYR, TUN, YEM]

R14_NAM:
  parent: World
  name: North America
  child: [CAN, GUM, SPM, USA]

R14_PAO:
  parent: World
  name: Pacific OECD
  child: [AUS, JPN, NZL]

R14_PAS:
  parent: World
  name: Other Pacific Asia
  child: [ASM, BRN, CCK, COK, CXR, FJI, FSM, IDN, KIR, KOR, MHL, MMR, MNP, MYS, NCL, NFK, NIU, NRU, PCN, PHL, PLW, PNG, PYF, SGP, SLB, THA, TKL, TLS, TON, TUV, VUT, WLF, WSM]

R14_RUS:
  parent: World
  name: Russia
  child: [RUS]

R14_SAS:
  parent: World
  name: South Asia
  child: [AFG, BGD, BTN, IND, LKA, MDV, NPL, PAK]

R14_SCS:
  parent: World
  name: Caspian States
  child: [ARM, AZE, GEO]

R14_UBM:
  parent: World
  name: Ukraine, Belarus, and Moldova
  child: [BLR, MDA, UKR]

R14_WEU:
  parent: World
  name: Western Europe
  child: [AND, AUT, BEL, CHE, CYP, DEU, DNK, ESP, FIN, FRA, FRO, GBR, GIB, GRC, GRL, IMN, IRL, ISL, ITA, LIE, LUX, MCO, MLT, NLD, NOR, PRT, SJM, SMR, SWE, TUR, VAT]

11-region aggregation (R11)

# Region code list
#
# - See message_data.tools.regions.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia

World:
  name: World
  description: R11 regions

R11_AFR:
  parent: World
  name: Sub-Saharan Africa
  child: [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, STP, SWZ, SYC, TCD, TGO, TZA, UGA, ZAF, ZMB, ZWE]
  iea-weo-region: Africa

R11_CPA:
  parent: World
  name: Centrally Planned Asia
  child: [CHN, HKG, KHM, LAO, MNG, PRK, VNM]
  iea-weo-region: China

R11_EEU:
  parent: World
  name: Central and Eastern Europe
  description: >-
    Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list,
    even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, BGR, BIH, CZE, EST, HRV, HUN, LTU, LVA, MKD, MNE, POL, ROU, SCG, SRB, SVK, SVN, YUG]
  iea-weo-region: European Union

R11_FSU:
  parent: World
  name: Former Soviet Union
  child: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]
  iea-weo-region: Russia

R11_LAM:
  parent: World
  name: Latin America and The Caribbean
  description: >-
    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT),
    but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRY, SLV, SUR, SXM, TCA, TTO, URY, VCT, VEN, VGB]
  iea-weo-region: Brazil

R11_MEA:
  parent: World
  name: Middle East and North Africa
  child: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR, OMN, PSE, QAT, SAU, SDN, SSD, SYR, TUN, YEM]
  iea-weo-region: Middle East

R11_NAM:
  parent: World
  name: North America
  child: [CAN, GUM, PRI, SPM, USA, VIR]
  iea-weo-region: United States

R11_PAO:
  parent: World
  name: Pacific OECD
  child: [AUS, JPN, NZL]
  iea-weo-region: Japan

R11_PAS:
  parent: World
  name: Other Pacific Asia
  description: >-
    Trust Territory of the Pacific Islands (PCI) still included in this list,
    but it was dissolved into MHL, FSM, MNP and PLW in 1986.
  child: [ASM, BRN, CCK, COK, CXR, FJI, FSM, IDN, KIR, KOR, MAC, MHL, MMR, MNP, MYS, NCL, NFK, NIU, NRU, PCI, PCN, PHL, PLW, PNG, PYF, SGP, SLB, THA, TKL, TLS, TON, TUV, TWN, VUT, WLF, WSM]
  iea-weo-region: India

R11_SAS:
  parent: World
  name: South Asia
  child: [AFG, BGD, BTN, IND, LKA, MDV, NPL, PAK]
  iea-weo-region: India

R11_WEU:
  parent: World
  name: Western Europe
  child: [AND, AUT, BEL, CHE, CYP, DEU, DNK, ESP, FIN, FRA, FRO, GBR, GIB, GRC, GRL, IMN, IRL, ISL, ITA, LIE, LUX, MCO, MLT, NLD, NOR, PRT, SJM, SMR, SWE, TUR, VAT]
  iea-weo-region: European Union

12-region aggregation (R12)

# Region code list
#
# - See message_ix_models.model.structure.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia
#
# For the meaning and usage of specific annotations, see:
# - iea-weo-region: message_ix_models.tools.iea.weo
# - material-region: message_ix_models.model.material.data_util.get_region_map
#   Codes were copied from R12_SSP_V1.yaml, currently only stored in private repository:
#   https://github.com/iiasa/message_data/blob/materials_2023_move2/data/node/R12_SSP_V1.yaml
#
#   Entries are ordered:
#   1. "*", if applicable.
#   2. Any ISO 3166-1 alpha-3 codes, in alphabetical order.
#   3. Any non-ISO codes, in alphabetical order.

World:
  name: World
  description: R12 regions

R12_AFR:
  parent: World
  name: Sub-Saharan Africa
  child: [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, STP, SWZ, SYC, TCD, TGO, TZA, UGA, ZAF, ZMB, ZWE]
  iea-weo-region: Africa
  material-region: [IIASA_AFRICA]

R12_RCPA:
  parent: World
  name: Rest Centrally Planned Asia
  child: [KHM, LAO, MNG, PRK, VNM]
  iea-weo-region: China
  material-region: ["*"]

R12_CHN:
  parent: World
  name: China
  child: [CHN, HKG]
  iea-weo-region: China
  material-region: [CHINAREG]

R12_EEU:
  parent: World
  name: Central and Eastern Europe
  description: >-
    Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list,
    even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, BGR, BIH, CZE, EST, HRV, HUN, LTU, LVA, MKD, MNE, POL, ROU, SCG, SRB, SVK, SVN, YUG]
  iea-weo-region: European Union
  # All children explicitly defined for "material-region" here, instead of using "*"
  # since YUG should not be included here (IEA EWEB data is only used from 1990 onwards)
  # See discussion here:
  # https://github.com/iiasa/message-ix-models/pull/201#discussion_r1656828874
  material-region: [ALB, BGR, BIH, CZE, EST, HRV, HUN, LTU, LVA, MKD, MNE, POL, ROU, SRB, SVK, SVN, KOSOVO]

R12_FSU:
  parent: World
  name: Former Soviet Union
  child: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]
  iea-weo-region: Russia
  material-region: ["*"]

R12_LAM:
  parent: World
  name: Latin America and The Caribbean
  description: >-
    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT),
    but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRY, SLV, SUR, SXM, TCA, TTO, URY, VCT, VEN, VGB]
  iea-weo-region: Brazil
  material-region: [CHL, COL, CRI, MEX, LATAMER]

R12_MEA:
  parent: World
  name: Middle East and North Africa
  child: [ARE, BHR, DZA, EGY, ESH, IRN, IRQ, ISR, JOR, KWT, LBN, LBY, MAR, OMN, PSE, QAT, SAU, SDN, SSD, SYR, TUN, YEM]
  iea-weo-region: Middle East
  material-region: [DZA, EGY, ISR, LBY, MAR, SDN, SSD, TUN, ASME, MPALESTINE]

R12_NAM:
  parent: World
  name: North America
  child: [CAN, GUM, PRI, SPM, USA, VIR]
  iea-weo-region: United States
  material-region: [CAN, USA]

R12_PAO:
  parent: World
  name: Pacific OECD
  child: [AUS, JPN, NZL]
  iea-weo-region: Japan
  material-region: ["*"]

R12_PAS:
  parent: World
  name: Other Pacific Asia
  description: >-
    Trust Territory of the Pacific Islands (PCI) still included in this list,
    but it was dissolved into MHL, FSM, MNP and PLW in 1986.
  child: [ASM, BRN, CCK, COK, CXR, FJI, FSM, IDN, KIR, KOR, MAC, MHL, MMR, MNP, MYS, NCL, NFK, NIU, NRU, PCI, PCN, PHL, PLW, PNG, PYF, SGP, SLB, THA, TKL, TLS, TON, TUV, TWN, VUT, WLF, WSM]
  iea-weo-region: India
  material-region: [BRN, IDN, KOR, MMR, MYS, PHL, SGP, THA, TWN, IIASA_PAS]

R12_SAS:
  parent: World
  name: South Asia
  child: [AFG, BGD, BTN, IND, LKA, MDV, NPL, PAK]
  iea-weo-region: India
  material-region: ["*", IIASA_SAS]

R12_WEU:
  parent: World
  name: Western Europe
  child: [AND, AUT, BEL, CHE, CYP, DEU, DNK, ESP, FIN, FRA, FRO, GBR, GIB, GRC, GRL, IMN, IRL, ISL, ITA, LIE, LUX, MCO, MLT, NLD, NOR, PRT, SJM, SMR, SWE, TUR, VAT]
  iea-weo-region: European Union
  material-region: ["*", GREENLAND]

5-region aggregation (RCP)

# Codes for the "node" dimension of the Representative Concentration Pathways
#
# - See message_data.tools.regions.
# - Since ixmp does not support the "." character in IDs, the names "R5.2ASIA"
#   are transformed to "R5_ASIA" etc. The original code is left in a
#   description.
# - The ISO 3166-1 alpha-3 codes are not defined in this file, but loaded from
#   a copy of the ISO database, e.g. in pycountry.
# - Among others, there are no assignments for:
#   - ATA Antarctica
#   - IOT British Indian Ocean Territory
#   - SGS South Georgia

World:
  name: World
  description: RCP regions

R5_ASIA:
  parent: World
  description: |-
    Officially "R5.2ASIA".

    Trust Territory of the Pacific Islands (PCI) still included in this list, but it was dissolved into MHL, FSM, MNP and PLW in 1986.
  child: [AFG, ASM, BGD, BRN, BTN, CCK, CHN, COK, CXR, FJI, FSM, GUM, HKG, IDN, IND, KHM, KIR, KOR, LAO, LKA, MAC, MDV, MHL, MMR, MNG, MNP, MYS, MYT, NCL, NFK, NIU, NPL, NRU, PAK, PCI, PCN, PHL, PLW, PNG, PRK, PYF, SGP, SLB, SYC, THA, TKL, TLS, TON, TUV, TWN, VNM, VUT, WSM]

R5_LAM:
  parent: World
  description: |-
    Officially "R5.2LAM".

    The source includes “Netherlands Antilles” which has a provisional ISO 3166-2 alpha-3 code (ANT), but is not a country. It was dissolved in 2010 into BES, CUW and SXM, also included.
  child: [ABW, AIA, ANT, ARG, ATG, BES, BHS, BLZ, BMU, BOL, BRA, BRB, CHL, COL, CRI, CUB, CUW, CYM, DMA, DOM, ECU, GLP, GRD, GTM, GUF, GUY, HND, HTI, JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRY, SLV, SUR, SXM, TTO, URY, VCT, VEN]

R5_MAF:
  parent: World
  description: Officially "R5.2MAF".
  child: [AGO, ARE, BDI, BEN, BFA, BHR, BWA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI, DZA, EGY, ERI, ESH, ETH, GAB, GHA, GIN, GMB, GNB, GNQ, IRN, IRQ, ISR, JOR, KEN, KWT, LBN, LBR, LBY, LSO, MAR, MDG, MLI, MOZ, MRT, MUS, MWI, NAM, NER, NGA, OMN, PSE, QAT, REU, RWA, SAU, SDN, SEN, SLE, SOM, SSD, STP, SWZ, SYR, TCD, TGO, TUN, TZA, UGA, YEM, ZAF, ZMB, ZWE]

R5_OECD:
  parent: World
  description: |-
    Officially "R5.2OECD".

    Serbia and Montenegro (SCG) and Yugoslavia (YUG) still included in this list, even though their ISO 3166-1 codes were deleted in 2006 and 2003, respectively.
  child: [ALB, AND, AUS, AUT, BEL, BGR, BIH, CAN, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FLK, FRA, FRO, GBR, GIB, GRC, GRL, HRV, HUN, IMN, IRL, ISL, ITA, JPN, LIE, LTU, LUX, LVA, MCO, MKD, MLT, MNE, NLD, NOR, NZL, POL, PRI, PRT, ROU, SCG, SHN, SJM, SMR, SPM, SRB, SVK, SVN, SWE, TCA, TUR, USA, VAT, VGB, VIR, WLF, YUG]

R5_REF:
  parent: World
  description: Officially "R5.2REF".
  child: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]

Others

These include models scoped to a single country or region, or a subset of all countries or regions, as well as code lists used in specific data sets from which message_ix_models handles data.

ADVANCE project (ADVANCE)

# Node code list for the ADVANCE project
#
# Source: https://db1.ene.iiasa.ac.at/ADVANCEDB/dsd?Action=htmlpage&page=10
# Transcribed 2022-07-22 by P.N. Kishimoto
#

World:
  # Countries represented individually
  child: [BRA, CHN, IND, JPN, RUS, USA]

EU:
  description: >-
    European Union (28 member states from the accession of HRV in 2013 to the
    withdrawal of GBR in 2020).
  child: [AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HRV, HUN, IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROU, SVK, SVN, SWE]

OECD90+EU:
  description: Includes the OECD 1990 countries as well as EU members and candidates.
  child: [ALB, AUS, AUT, BEL, BGR, BIH, CAN, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FJI, FRA, GBR, GRC, GUM, HRV, HUN, IRL, ISL, ITA, JPN, LTU, LUX, LVA, MKD, MLT, MNE, NCL, NLD, NOR, NZL, POL, PRT, PYF, ROU, SLB, SRB, SVK, SVN, SWE, TUR, USA, VUT, WSM]

REF:
  description: Countries from the Reforming Ecomonies of the Former Soviet Union.
  child: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]

ASIA:
  description: The region includes most Asian countries with the exception of the Middle East, Japan and Former Soviet Union states.
  child: [AFG, BGD, BRN, BTN, CHN, HKG, IDN, IND, KHM, KOR, LAO, LKA, MAC, MDV, MMR, MNG, MYS, NPL, PAK, PHL, PNG, PRK, SGP, THA, TMP, TWN, VNM]

MAF:
  description: This region includes the countries of the Middle East and Africa.
  child: [DZA, AGO, ARE, BDA, BEN, BFA, BHR, BWA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI, EGY, ERI, ESH, ETH, GAB, GHA, GIN, GMB, GNB, GNQ, IRN, IRQ, ISR, JOR, KEN, KWT, LBN, LBR, LBY, LSO, MAR, MDG, MLI, MOZ, MRT, MUS, MWI, NAM, NER, NGA, OMN, QAT, REU, RQA, SAU, SDN, SEN, SLE, SOM, SWZ, SYR, TCD, TGO, TUN, TZA, UGA, YEM, ZAF, ZMB, ZWE]

LAM:
  description: This region includes the countries of Latin America and the Caribbean.
  child: [ARG, ANT, BHS, BLZ, BOL, BRA, BRB, CHL, COL, CRA, CUB, DOM, EDU, GLP, GTM, GUY, HND, HTI, JAM, MEX, MTQ, NIC, PAN, PER, PRI, PRY, SLV, SUR, TTO, URY, VEN]

Israel (ISR)

# Codes for the "node" dimension of the MESSAGE-IL model

World:
  name: World
  description: MESSAGE-IL regions

Israel:
  name: Israel
  parent: World
  child: [ISR]

Zambia (ZMB)

# Codes for the "node" dimension of the MESSAGE-ZM model

World:
  name: World
  description: MESSAGE-ZM regions

Zambia:
  name: Zambia
  parent: World
  child: [ZMB]