get_region_per_countries() #1034
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,6 +22,7 @@ | |
| __all__ = ["ImpfTropCyclone", "ImpfSetTropCyclone", "IFTropCyclone"] | ||
|
|
||
| import logging | ||
| from enum import Enum | ||
|
|
||
| import numpy as np | ||
| import pandas as pd | ||
|
|
@@ -34,6 +35,135 @@ | |
| LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class CountryCode(Enum): | ||
|
There was a problem hiding this comment. Why does this enum contain numerical and alpha-3 country codes? Conversion between the two can be done by |
||
| """ | ||
| Enum class that links ISO country codes (both iso3a and iso3n) to specific regions and | ||
| associated impact function IDs. | ||
|
|
||
| Attributes | ||
| ---------- | ||
| ISO3A: dict | ||
| A mapping of region names to lists of 3-letter ISO country codes (iso3a). | ||
| ISO3N: dict | ||
| A mapping of region names to lists of numeric ISO country codes (iso3n). | ||
| IMPF_ID: dict | ||
| A mapping of region names to corresponding impact function IDs. | ||
| REGION_NAME: dict | ||
| A mapping of region names to their descriptive names. | ||
| """ | ||
|
|
||
| # fmt: off | ||
| ISO3N = { | ||
| "NA1": [ | ||
| 660, 28, 32, 533, 44, 52, 84, 60, 68, 132, | ||
| 136, 152, 170, 188, 192, 212, 214, 218, 222, 238, | ||
| 254, 308, 312, 320, 328, 332, 340, 388, 474, 484, | ||
| 500, 558, 591, 600, 604, 630, 654, 659, 662, 670, | ||
| 534, 740, 780, 796, 858, 862, 92, 850, | ||
| ], | ||
| "NA2": [124, 840], | ||
| "NI": [ | ||
| 4, 51, 31, 48, 50, 64, 262, 232, 231, 268, | ||
| 356, 364, 368, 376, 400, 398, 414, 417, 422, 462, | ||
| 496, 104, 524, 512, 586, 634, 682, 706, 144, 760, | ||
| 762, 795, 800, 784, 860, 887, | ||
| ], | ||
| "OC": [ | ||
| 16, 36, 184, 242, 258, 316, 296, 584, 583, 520, | ||
| 540, 554, 570, 574, 580, 585, 598, 612, 882, 90, | ||
| 626, 772, 776, 798, 548, 876, | ||
| ], | ||
| "SI": [174, 180, 748, 450, 454, 466, 480, 508, 710, 834, 716], | ||
| "WP1": [116, 360, 418, 458, 764, 704], | ||
| "WP2": [608], | ||
| "WP3": [156], | ||
| "WP4": [344, 392, 410, 446, 158], | ||
| "ROW": [ | ||
| 8, 12, 20, 24, 10, 40, 112, 56, 204, 535, | ||
| 70, 72, 74, 76, 86, 96, 100, 854, 108, 120, | ||
| 140, 148, 162, 166, 178, 191, 531, 196, 203, 384, | ||
| 208, 818, 226, 233, 234, 246, 250, 260, 266, 270, | ||
| 276, 288, 292, 300, 304, 831, 324, 624, 334, 336, | ||
| 348, 352, 372, 833, 380, 832, 404, 408, 983, 428, | ||
| 426, 430, 434, 438, 440, 442, 470, 478, 175, 498, | ||
| 492, 499, 504, 516, 528, 562, 566, 807, 578, 275, | ||
| 616, 620, 642, 643, 646, 638, 652, 663, 666, 674, | ||
| 678, 686, 688, 690, 694, 702, 703, 705, 239, 728, | ||
| 724, 729, 744, 752, 756, 768, 788, 792, 804, 826, | ||
| 581, 732, 894, 248, | ||
| ], | ||
| } | ||
| ISO3A = { | ||
| "NA1": [ | ||
| "AIA", "ATG", "ARG", "ABW", "BHS", "BRB", "BLZ", "BMU", "BOL", "CPV", | ||
| "CYM", "CHL", "COL", "CRI", "CUB", "DMA", "DOM", "ECU", "SLV", "FLK", | ||
| "GUF", "GRD", "GLP", "GTM", "GUY", "HTI", "HND", "JAM", "MTQ", "MEX", | ||
| "MSR", "NIC", "PAN", "PRY", "PER", "PRI", "SHN", "KNA", "LCA", "VCT", | ||
| "SXM", "SUR", "TTO", "TCA", "URY", "VEN", "VGB", "VIR", | ||
| ], | ||
| "NA2": ["CAN", "USA"], | ||
| "NI": [ | ||
| "AFG", "ARM", "AZE", "BHR", "BGD", "BTN", "DJI", "ERI", "ETH", "GEO", | ||
| "IND", "IRN", "IRQ", "ISR", "JOR", "KAZ", "KWT", "KGZ", "LBN", "MDV", | ||
| "MNG", "MMR", "NPL", "OMN", "PAK", "QAT", "SAU", "SOM", "LKA", "SYR", | ||
| "TJK", "TKM", "UGA", "ARE", "UZB", "YEM", | ||
| ], | ||
| "OC": [ | ||
| "ASM", "AUS", "COK", "FJI", "PYF", "GUM", "KIR", "MHL", "FSM", "NRU", | ||
| "NCL", "NZL", "NIU", "NFK", "MNP", "PLW", "PNG", "PCN", "WSM", "SLB", | ||
| "TLS", "TKL", "TON", "TUV", "VUT", "WLF", | ||
| ], | ||
| "SI": [ | ||
| "COM", "COD", "SWZ", "MDG", "MWI", "MLI", "MUS", "MOZ", "ZAF", "TZA", | ||
| "ZWE", | ||
| ], | ||
| "WP1": ["KHM", "IDN", "LAO", "MYS", "THA", "VNM"], | ||
| "WP2": ["PHL"], | ||
| "WP3": ["CHN"], | ||
| "WP4": ["HKG", "JPN", "KOR", "MAC", "TWN"], | ||
| "ROW": [ | ||
| "ALB", "DZA", "AND", "AGO", "ATA", "AUT", "BLR", "BEL", "BEN", "BES", | ||
| "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "CMR", | ||
| "CAF", "TCD", "CXR", "CCK", "COG", "HRV", "CUW", "CYP", "CZE", "CIV", | ||
| "DNK", "EGY", "GNQ", "EST", "FRO", "FIN", "FRA", "ATF", "GAB", "GMB", | ||
| "DEU", "GHA", "GIB", "GRC", "GRL", "GGY", "GIN", "GNB", "HMD", "VAT", | ||
| "HUN", "ISL", "IRL", "IMN", "ITA", "JEY", "KEN", "PRK", "XKX", "LVA", | ||
| "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MLT", "MRT", "MYT", "MDA", | ||
| "MCO", "MNE", "MAR", "NAM", "NLD", "NER", "NGA", "MKD", "NOR", "PSE", | ||
| "POL", "PRT", "ROU", "RUS", "RWA", "REU", "BLM", "MAF", "SPM", "SMR", | ||
| "STP", "SEN", "SRB", "SYC", "SLE", "SGP", "SVK", "SVN", "SGS", "SSD", | ||
| "ESP", "SDN", "SJM", "SWE", "CHE", "TGO", "TUN", "TUR", "UKR", "GBR", | ||
| "UMI", "ESH", "ZMB", "ALA", | ||
| ], | ||
| } | ||
| # fmt: on | ||
| IMPF_ID = { | ||
| "NA1": 1, | ||
| "NA2": 2, | ||
| "NI": 3, | ||
| "OC": 4, | ||
| "SI": 5, | ||
| "WP1": 6, | ||
| "WP2": 7, | ||
| "WP3": 8, | ||
| "WP4": 9, | ||
| "ROW": 10, | ||
| } | ||
|
|
||
| REGION_NAME = { | ||
| "NA1": "Caribbean and Mexico", | ||
| "NA2": "USA and Canada", | ||
| "NI": "North Indian", | ||
| "OC": "Oceania", | ||
| "SI": "South Indian", | ||
| "WP1": "South East Asia", | ||
| "WP2": "Philippines", | ||
| "WP3": "China Mainland", | ||
| "WP4": "North West Pacific", | ||
| "ROW": "Rest of The World", | ||
| } | ||
|
|
||
|
|
||
| class ImpfTropCyclone(ImpactFunc): | ||
| """Impact functions for tropical cyclones.""" | ||
|
|
||
|
|
@@ -311,118 +441,74 @@ | |
| """ | ||
| if not region: | ||
| region = "all" | ||
|
|
||
| if region == "all": | ||
| return ( | ||
| CountryCode.REGION_NAME.value, | ||
| CountryCode.IMPF_ID.value, | ||
| CountryCode.ISO3N.value, | ||
| CountryCode.ISO3A.value, | ||
| ) | ||
|
|
||
| return ( | ||
| CountryCode.REGION_NAME.value[region], | ||
| CountryCode.IMPF_ID.value[region], | ||
| CountryCode.ISO3N.value[region], | ||
| CountryCode.ISO3A.value[region], | ||
| ) | ||
|
|
||
| @staticmethod | ||
| def get_impf_id_regions_per_countries( | ||
|
Check warning on line 461 in climada/entity/impact_funcs/trop_cyclone.py
|
||
| countries: list = None, code_type: str = "ISO3A" | ||
| ) -> tuple: | ||
| """Return the impact function id and the region corresponding to a list of countries, | ||
| or a single country. | ||
|
|
||
| Parameters: | ||
| ----------- | ||
| countries : list | ||
| List containing the ISO codes of the country, which should be either | ||
| in string format if the code is "ISO3A" or an integer if "ISO3N", see code_type below. | ||
| code_type : str | ||
| Either "ISO3A" or "ISO3N". "ISO3A" stands for "ISO 3166-1 alpha-3" which is a | ||
| three-letter country code, "ISO3N" stands for "ISO 3166-1 numeric" which is a | ||
| three-digit country code, the numeric version of "ISO3A". For example, for Switzerland: | ||
| the "ISO3A" code is "CHE" and the "ISO3N" is 756. | ||
|
Comment on lines
+472
to
+476
There was a problem hiding this comment. This is inconsistent with |
||
|
|
||
| Returns: | ||
| -------- | ||
| impf_ids : list | ||
| List of impact function ids matching the countries. | ||
|
Comment on lines
+480
to
+481
There was a problem hiding this comment. Why not immediately return the appropriate impact function (set)s? |
||
| regions_ids : list | ||
| List of the region ids. Regions are a container of countries as defined in: | ||
| https://nhess.copernicus.org/articles/21/393/2021/nhess-21-393-2021.pdf, and implemented | ||
| in the CountryCode Enum Class. Example: "NA1", "NA2", ... | ||
| regions_names : list | ||
| List of the regions names. Example: "Caribbean and Mexico", "USA and Canada", ... | ||
| """ | ||
|
|
||
| if code_type not in {"ISO3A", "ISO3N"}: | ||
|
There was a problem hiding this comment. Why is |
||
| raise ValueError("code_type must be either 'iso3a' or 'iso3n'") | ||
| elif not all(isinstance(country, type(countries[0])) for country in countries): | ||
| raise ValueError("All elements in the list must be of the same type.") | ||
|
Comment on lines
+492
to
+493
There was a problem hiding this comment. Why? It's easy to decide on a per-element basis if a numerical or an alpha-3 code is given. |
||
| elif code_type == "ISO3A" and isinstance((countries[0]), int): | ||
| raise ValueError("ISO3A code type cannot have integer values.") | ||
| elif code_type == "ISO3N" and isinstance((countries[0]), str): | ||
| raise ValueError("ISO3N code type cannot have string values.") | ||
|
Comment on lines
+491
to
+497
There was a problem hiding this comment. Please choose clear words / variable names. Here it is neither consistent (e.e. iso3a and ISO3A), nor standard. |
||
|
|
||
| region_country_dict = getattr(CountryCode, code_type).value | ||
| # Find region | ||
| regions_ids = [ | ||
| region_id | ||
| for country in countries | ||
| for region_id, countr_in_region_id in region_country_dict.items() | ||
| if country in countr_in_region_id | ||
| ] | ||
| # Find impact function id | ||
| impf_ids = [CountryCode.IMPF_ID.value[region] for region in regions_ids] | ||
| regions_name = [CountryCode.REGION_NAME.value[region] for region in regions_ids] | ||
|
|
||
| return impf_ids, regions_ids, regions_name | ||
|
|
||
|
|
||
| @deprecated( | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add at least one test with multiple countries.