Replace iso3_codes with countries (#53)

iiasa · Oct 3, 2024 · 400a209 · 400a209
1 parent b919b1e
commit 400a209
Show file tree

Hide file tree

Showing 33 changed files with 1,032 additions and 990 deletions.
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml
@@ -0,0 +1,8 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml
@@ -17,10 +17,10 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.9
+    - name: Set up Python 3.11
       uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
 
     - name: Install requirements
       run: pip install -r requirements.txt

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # EU Climate Advisory Board Scenario Explorer Workflow
 
-Copyright 2022-2023 IIASA
+Copyright 2023-2024 IIASA
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ## Overview
 

diff --git a/definitions/region/countries.yaml b/definitions/region/countries.yaml
@@ -190,4 +190,4 @@
       iso2: GB
       iso2_alt: UK # the European Commission uses alternative ISO2 codes
       iso3_codes: GBR
-      synonyms: ['Great Britain']
+      synonyms: ['Great Britain']
diff --git a/definitions/region/european-regions.yaml b/definitions/region/european-regions.yaml
@@ -16,19 +16,19 @@
 
   - EU27 & UK:
       definition: EU27 + UK
-      iso3_codes: [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]
+      countries: [Austria, Belgium, Bulgaria, Cyprus, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, United Kingdom, Greece, Croatia,
+        Hungary, Ireland, Italy, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Sweden]
       notes: Formerly known as EU28.
   - EFTA:
       definition: IS + LI + NO + CH
-      iso3_codes: [CHE, ISL, LIE, NOR]
+      countries: [Switzerland, Iceland, Liechtenstein, Norway]
       notes: European Free Trade Association
       source: https://en.wikipedia.org/wiki/European_Free_Trade_Association
   - EU27 & EFTA:
       definition: EU27 + EFTA
-      iso3_codes: [AUT, BEL, BGR, CHE, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC,
-        HRV, HUN, IRL, ISL, ITA, LIE, LTU, LUX, LVA, MLT, NLD, NOR, POL, PRT, ROU, SVK,
-        SVN, SWE]
+      countries: [Austria, Belgium, Bulgaria, Switzerland, Cyprus, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, United Kingdom, Greece,
+        Croatia, Hungary, Ireland, Iceland, Italy, Liechtenstein, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Norway, Poland, Portugal, Romania, Slovakia,
+        Slovenia, Sweden]
       notes: This region is the jurisdiction of the EU ETS as of 2021 (post-Brexit).
       source: https://ec.europa.eu/clima/eu-action/eu-emissions-trading-system-eu-ets_en 
   - Balkans:
@@ -67,12 +67,12 @@
   - EU27:
       definition: AT + BE + BG + HR + CY + CZ + DK + EE + FI + FR + DE + GR + HU +
         IE + IT + LV + LT + LU + MT + PL + PT + RO + SK + SI + ES + SE + NL
-      iso3_codes: [AUT, BEL, BGR, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GRC, HRV, HUN,
-        IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, ROU, SVK, SVN, SWE]
+      countries: [Austria, Belgium, Bulgaria, Cyprus, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, Greece, Croatia, Hungary,
+        Ireland, Italy, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Sweden]
       notes: membership as of February 1, 2020
   - EU27 (excl. Malta & Cyprus):
       definition: EU27 excluding CY + MT
-      iso3_codes: [AUT, BEL, BGR, CZE, DEU, DNK, ESP, EST, FIN, FRA, GRC, HRV, HUN,
-        IRL, ITA, LTU, LUX, LVA, NLD, POL, PRT, ROU, SVK, SVN, SWE]
+      countries: [Austria, Belgium, Bulgaria, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, Greece, Croatia, Hungary,
+        Ireland, Italy, Lithuania, Luxembourg, Latvia, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Sweden]
 
   # add more definitions of `EU*` above this line
diff --git a/definitions/region/global-regions.yaml b/definitions/region/global-regions.yaml
diff --git a/definitions/region/model_native_regions/AIM_2.1.yaml b/definitions/region/model_native_regions/AIM_2.1.yaml
@@ -1,45 +1,45 @@
 - AIM/CGE 2.1:
   - AIM/CGE 2.1|Brazil:
-      iso3_codes: BRA
+      countries: [Brazil]
   - AIM/CGE 2.1|Canada:
-      iso3_codes: CAN
+      countries: [Canada]
   - AIM/CGE 2.1|China:
-      iso3_codes: [CHN, HKG]
+      countries: [China, Hong Kong]
   - AIM/CGE 2.1|Former USSR:
-      iso3_codes: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]
+      countries: [Armenia, Azerbaijan, Belarus, Georgia, Kazakhstan, Kyrgyzstan, Moldova, Russian Federation, Tajikistan, Turkmenistan, Ukraine, Uzbekistan]
   - AIM/CGE 2.1|India:
-      iso3_codes: IND
+      countries: [India]
   - AIM/CGE 2.1|Japan:
-      iso3_codes: JPN
+      countries: [Japan]
   - AIM/CGE 2.1|Turkey:
-      iso3_codes: TUR
+      countries: [Turkey]
   - AIM/CGE 2.1|USA:
-      iso3_codes: USA
+      countries: [United States]
   - AIM/CGE 2.1|Other Africa:
-      iso3_codes: [AGO, BDI, BEN, BFA, BWA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI,
-        ERI, ESH, 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]
+      countries: [Angola, Burundi, Benin, Burkina Faso, Botswana, Central African Republic, Côte d'Ivoire, Cameroon, Democratic Republic of the Congo, Congo, Comoros, Cabo Verde, Djibouti,
+        Eritrea, Western Sahara, Ethiopia, Gabon, Ghana, Guinea, Gambia, Guinea-Bissau, Equatorial Guinea, Kenya, Liberia, Lesotho, Madagascar, Mali, Mozambique,
+        Mauritania, Mauritius, Malawi, Mayotte, Namibia, Niger, Nigeria, Réunion, Rwanda, Sudan, Senegal, "Saint Helena, Ascension and Tristan da Cunha", Sierra Leone, Somalia, Sao Tome and Principe,
+        Eswatini, Seychelles, Chad, Togo, Tanzania, Uganda, South Africa, Zambia, Zimbabwe]
   - AIM/CGE 2.1|EU:
-      iso3_codes: [AUT, BEL, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HUN,
-        IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, SVK, SVN, SWE]
+      countries: [Austria, Belgium, Cyprus, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, United Kingdom, Greece, Hungary,
+        Ireland, Italy, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Poland, Portugal, Slovakia, Slovenia, Sweden]
   - AIM/CGE 2.1|Rest of Europe:
-      iso3_codes: [ALB, AND, BGR, BIH, CHE, FRO, GIB, HRV, ISL, LIE, MCO, MKD, MNE,
-        NOR, ROU, SJM, SMR, SRB, VAT]
+      countries: [Albania, Andorra, Bulgaria, Bosnia and Herzegovina, Switzerland, Faroe Islands, Gibraltar, Croatia, Iceland, Liechtenstein, Monaco, North Macedonia, Montenegro,
+        Norway, Romania, Svalbard and Jan Mayen, San Marino, Serbia, Vatican]
   - AIM/CGE 2.1|Rest of Latin America:
-      iso3_codes: [ABW, AIA, ARG, ATG, BES, CUW, SXM, BHS, BLZ, BMU, BOL, BRB, BVT, CHL, COL,
-        CRI, CUB, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GRL, GTM, GUF, GUY, HND, HTI,
-        JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRI, PRY, SGS, SLV, SPM, SUR,
-        TCA, TTO, URY, VCT, VEN, VGB, VIR]
+      countries: [Aruba, Anguilla, Argentina, Antigua and Barbuda, "Bonaire, Sint Eustatius and Saba", Curaçao, Sint Maarten (Dutch part), Bahamas, Belize, Bermuda, Bolivia, Barbados, Bouvet Island, Chile, Colombia,
+        Costa Rica, Cuba, Cayman Islands, Dominica, Dominican Republic, Ecuador, Falkland Islands (Malvinas), Guadeloupe, Grenada, Greenland, Guatemala, French Guiana, Guyana, Honduras, Haiti,
+        Jamaica, Saint Kitts and Nevis, Saint Lucia, Mexico, Montserrat, Martinique, Nicaragua, Panama, Peru, Puerto Rico, Paraguay, South Georgia and the South Sandwich Islands, El Salvador, Saint Pierre and Miquelon, Suriname,
+        Turks and Caicos Islands, Trinidad and Tobago, Uruguay, Saint Vincent and the Grenadines, Venezuela, British Virgin Islands, United States Virgin Islands]
   - AIM/CGE 2.1|Middle East:
-      iso3_codes: [ARE, BHR, IRN, IRQ, ISR, JOR, KWT, LBN, OMN, QAT, SAU, SYR, YEM]
+      countries: [United Arab Emirates, Bahrain, Iran, Iraq, Israel, Jordan, Kuwait, Lebanon, Oman, Qatar, Saudi Arabia, Syria, Yemen]
   - AIM/CGE 2.1|North Africa:
-      iso3_codes: [DZA, EGY, LBY, MAR, TUN]
+      countries: [Algeria, Egypt, Libya, Morocco, Tunisia]
   - AIM/CGE 2.1|New Zealand and Australia:
-      iso3_codes: [AUS, NZL]
+      countries: [Australia, New Zealand]
   - AIM/CGE 2.1|Rest of Asia:
-      iso3_codes: [AFG, ASM, ATF, BGD, BRN, BTN, CCK, COK, CXR, FJI, FSM, GUM, HMD,
-        IOT, KIR, LKA, MDV, MHL, MNP, NCL, NFK, NIU, NPL, NRU, PAK, PCN, PLW, PNG,
-        PYF, SLB, TKL, TON, TUV, UMI, VUT, WLF, WSM]
+      countries: [Afghanistan, American Samoa, French Southern Territories, Bangladesh, Brunei Darussalam, Bhutan, Cocos (Keeling) Islands, Cook Islands, Christmas Island, Fiji, Micronesia, Guam, Heard Island and McDonald Islands,
+        British Indian Ocean Territory, Kiribati, Sri Lanka, Maldives, Marshall Islands, Northern Mariana Islands, New Caledonia, Norfolk Island, Niue, Nepal, Nauru, Pakistan, Pitcairn, Palau, Papua New Guinea,
+        French Polynesia, Solomon Islands, Tokelau, Tonga, Tuvalu, United States Minor Outlying Islands, Vanuatu, Wallis and Futuna, Samoa]
   - AIM/CGE 2.1|Rest of East and South East Asia:
-      iso3_codes: [IDN, KHM, KOR, LAO, MMR, MNG, MYS, PHL, PRK, SGP, THA, TLS, TWN, VNM]
+      countries: [Indonesia, Cambodia, South Korea, Laos, Myanmar, Mongolia, Malaysia, Philippines, North Korea, Singapore, Thailand, Timor-Leste, Taiwan, Viet Nam]
diff --git a/definitions/region/model_native_regions/AIM_2.2.yaml b/definitions/region/model_native_regions/AIM_2.2.yaml
@@ -1,45 +1,45 @@
 - AIM/CGE 2.2:
   - AIM/CGE 2.2|Brazil:
-      iso3_codes: BRA
+      countries: [Brazil]
   - AIM/CGE 2.2|Canada:
-      iso3_codes: CAN
+      countries: [Canada]
   - AIM/CGE 2.2|China:
-      iso3_codes: [CHN, HKG]
+      countries: [China, Hong Kong]
   - AIM/CGE 2.2|Former USSR:
-      iso3_codes: [ARM, AZE, BLR, GEO, KAZ, KGZ, MDA, RUS, TJK, TKM, UKR, UZB]
+      countries: [Armenia, Azerbaijan, Belarus, Georgia, Kazakhstan, Kyrgyzstan, Moldova, Russian Federation, Tajikistan, Turkmenistan, Ukraine, Uzbekistan]
   - AIM/CGE 2.2|India:
-      iso3_codes: IND
+      countries: [India]
   - AIM/CGE 2.2|Japan:
-      iso3_codes: JPN
+      countries: [Japan]
   - AIM/CGE 2.2|Turkey:
-      iso3_codes: TUR
+      countries: [Turkey]
   - AIM/CGE 2.2|USA:
-      iso3_codes: USA
+      countries: [United States]
   - AIM/CGE 2.2|Other Africa:
-      iso3_codes: [AGO, BDI, BEN, BFA, BWA, CAF, CIV, CMR, COD, COG, COM, CPV, DJI,
-        ERI, ESH, 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]
+      countries: [Angola, Burundi, Benin, Burkina Faso, Botswana, Central African Republic, Côte d'Ivoire, Cameroon, Democratic Republic of the Congo, Congo, Comoros, Cabo Verde, Djibouti,
+        Eritrea, Western Sahara, Ethiopia, Gabon, Ghana, Guinea, Gambia, Guinea-Bissau, Equatorial Guinea, Kenya, Liberia, Lesotho, Madagascar, Mali, Mozambique,
+        Mauritania, Mauritius, Malawi, Mayotte, Namibia, Niger, Nigeria, Réunion, Rwanda, Sudan, Senegal, "Saint Helena, Ascension and Tristan da Cunha", Sierra Leone, Somalia, Sao Tome and Principe,
+        Eswatini, Seychelles, Chad, Togo, Tanzania, Uganda, South Africa, Zambia, Zimbabwe]
   - AIM/CGE 2.2|EU:
-      iso3_codes: [AUT, BEL, CYP, CZE, DEU, DNK, ESP, EST, FIN, FRA, GBR, GRC, HUN,
-        IRL, ITA, LTU, LUX, LVA, MLT, NLD, POL, PRT, SVK, SVN, SWE]
+      countries: [Austria, Belgium, Cyprus, Czechia, Germany, Denmark, Spain, Estonia, Finland, France, United Kingdom, Greece, Hungary,
+        Ireland, Italy, Lithuania, Luxembourg, Latvia, Malta, Netherlands, Poland, Portugal, Slovakia, Slovenia, Sweden]
   - AIM/CGE 2.2|Rest of Europe:
-      iso3_codes: [ALB, AND, BGR, BIH, CHE, FRO, GIB, HRV, ISL, LIE, MCO, MKD, MNE,
-        NOR, ROU, SJM, SMR, SRB, VAT]
+      countries: [Albania, Andorra, Bulgaria, Bosnia and Herzegovina, Switzerland, Faroe Islands, Gibraltar, Croatia, Iceland, Liechtenstein, Monaco, North Macedonia, Montenegro,
+        Norway, Romania, Svalbard and Jan Mayen, San Marino, Serbia, Vatican]
   - AIM/CGE 2.2|Rest of Latin America:
-      iso3_codes: [ABW, AIA, ARG, ATG, BES, CUW, SXM, BHS, BLZ, BMU, BOL, BRB, BVT, CHL, COL,
-        CRI, CUB, CYM, DMA, DOM, ECU, FLK, GLP, GRD, GRL, GTM, GUF, GUY, HND, HTI,
-        JAM, KNA, LCA, MEX, MSR, MTQ, NIC, PAN, PER, PRI, PRY, SGS, SLV, SPM, SUR,
-        TCA, TTO, URY, VCT, VEN, VGB, VIR]
+      countries: [Aruba, Anguilla, Argentina, Antigua and Barbuda, "Bonaire, Sint Eustatius and Saba", Curaçao, Sint Maarten (Dutch part), Bahamas, Belize, Bermuda, Bolivia, Barbados, Bouvet Island, Chile, Colombia,
+        Costa Rica, Cuba, Cayman Islands, Dominica, Dominican Republic, Ecuador, Falkland Islands (Malvinas), Guadeloupe, Grenada, Greenland, Guatemala, French Guiana, Guyana, Honduras, Haiti,
+        Jamaica, Saint Kitts and Nevis, Saint Lucia, Mexico, Montserrat, Martinique, Nicaragua, Panama, Peru, Puerto Rico, Paraguay, South Georgia and the South Sandwich Islands, El Salvador, Saint Pierre and Miquelon, Suriname,
+        Turks and Caicos Islands, Trinidad and Tobago, Uruguay, Saint Vincent and the Grenadines, Venezuela, British Virgin Islands, United States Virgin Islands]
   - AIM/CGE 2.2|Middle East:
-      iso3_codes: [ARE, BHR, IRN, IRQ, ISR, JOR, KWT, LBN, OMN, QAT, SAU, SYR, YEM]
+      countries: [United Arab Emirates, Bahrain, Iran, Iraq, Israel, Jordan, Kuwait, Lebanon, Oman, Qatar, Saudi Arabia, Syria, Yemen]
   - AIM/CGE 2.2|North Africa:
-      iso3_codes: [DZA, EGY, LBY, MAR, TUN]
+      countries: [Algeria, Egypt, Libya, Morocco, Tunisia]
   - AIM/CGE 2.2|New Zealand and Australia:
-      iso3_codes: [AUS, NZL]
+      countries: [Australia, New Zealand]
   - AIM/CGE 2.2|Rest of Asia:
-      iso3_codes: [AFG, ASM, ATF, BGD, BRN, BTN, CCK, COK, CXR, FJI, FSM, GUM, HMD,
-        IOT, KIR, LKA, MDV, MHL, MNP, NCL, NFK, NIU, NPL, NRU, PAK, PCN, PLW, PNG,
-        PYF, SLB, TKL, TON, TUV, UMI, VUT, WLF, WSM]
+      countries: [Afghanistan, American Samoa, French Southern Territories, Bangladesh, Brunei Darussalam, Bhutan, Cocos (Keeling) Islands, Cook Islands, Christmas Island, Fiji, Micronesia, Guam, Heard Island and McDonald Islands,
+        British Indian Ocean Territory, Kiribati, Sri Lanka, Maldives, Marshall Islands, Northern Mariana Islands, New Caledonia, Norfolk Island, Niue, Nepal, Nauru, Pakistan, Pitcairn, Palau, Papua New Guinea,
+        French Polynesia, Solomon Islands, Tokelau, Tonga, Tuvalu, United States Minor Outlying Islands, Vanuatu, Wallis and Futuna, Samoa]
   - AIM/CGE 2.2|Rest of East and South East Asia:
-      iso3_codes: [IDN, KHM, KOR, LAO, MMR, MNG, MYS, PHL, PRK, SGP, THA, TLS, TWN, VNM]
+      countries: [Indonesia, Cambodia, South Korea, Laos, Myanmar, Mongolia, Malaysia, Philippines, North Korea, Singapore, Thailand, Timor-Leste, Taiwan, Viet Nam]