Feature/wrapper_functions_api #500
Conversation
climada/util/api_client.py
Outdated
| @@ -844,6 +844,44 @@ def get_litpop_default(self, country=None, dump_dir=SYSTEM_DIR): | |||
| raise ValueError("country must be string or list of strings") | |||
| return self.get_exposures(exposures_type='litpop', dump_dir=dump_dir, properties=properties) | |||
|
|
|||
| def get_centroids(self, res_arcsec_land=150, res_arcsec_ocean=1800, extent=None, reg_id=None, country_iso3alpha=None, | |||
There was a problem hiding this comment.
I am not sure whether the attribute reg_id is very sensible here. This is a number that cannot really be known by a user of the API right? Anyway, the reg_id is the same as the country_iso3alpha correct? I would thus keep only one of the two, and only the one that is really understandable by a user.
There was a problem hiding this comment.
okay, it was just to follow the centroids.select() arguments. but probably country_iso3alpha is sufficient
| resolution for ocean centroids in arcsec. Default is 1800 | ||
| reg_id : int | ||
| region to filter according to region_id values | ||
| extent : tuple |
There was a problem hiding this comment.
Should we put the default to have min_lat = -60 and max_lat = 60? Also, the default is not explained. Is it the whole world?
There was a problem hiding this comment.
yes for now I put the whole world, I would keep it like that. Because for most hazards it makes sense to have the entire globe
There was a problem hiding this comment.
But is it cut at high/low latitudes or not? This would be important to know. The default extent could then be with +-60degrees?
| If min_lon > lon_max, the extend crosses the antimeridian and is | ||
| [lon_max, 180] + [-180, lon_min] | ||
| Borders are inclusive. | ||
| dump_dir : str |
There was a problem hiding this comment.
The country_iso3alpha is missing (also the reg_id, but I would remove that one probably, or make it clear that it is simply the country iso3 numeric.
climada/util/api_client.py
Outdated
| Returns | ||
| ------- | ||
| climada.hazard.centroids.Centroids | ||
| global centroids from the api |
There was a problem hiding this comment.
It is not always global, only by default.
climada/util/api_client.py
Outdated
| dataset = self.get_dataset_info("centroids", properties={'res_arcsec_land':res_arcsec_land, | ||
| 'res_arcsec_ocean':res_arcsec_ocean,'extent':extent_property}) |
There was a problem hiding this comment.
Maybe a check whether the data exist would be useful? Because the error message from get_dataset_info is not very useful if for instance I say res_arcsec_land=2500 and it does not exist...
climada/util/api_client.py
Outdated
| res_arcsec_land = str(res_arcsec_land) | ||
| res_arcsec_ocean = str(res_arcsec_ocean) |
There was a problem hiding this comment.
| res_arcsec_land = str(res_arcsec_land) | |
| res_arcsec_ocean = str(res_arcsec_ocean) |
climada/util/api_client.py
Outdated
| dataset = self.get_dataset_info("centroids", properties={'res_arcsec_land':res_arcsec_land, | ||
| 'res_arcsec_ocean':res_arcsec_ocean,'extent':extent_property}) |
There was a problem hiding this comment.
| dataset = self.get_dataset_info("centroids", properties={'res_arcsec_land':res_arcsec_land, | |
| 'res_arcsec_ocean':res_arcsec_ocean,'extent':extent_property}) | |
| dataset = self.get_dataset_info("centroids", properties={'res_arcsec_land':str(res_arcsec_land), | |
| 'res_arcsec_ocean':st(res_arcsec_ocean),'extent':extent_property}) |
climada/util/api_client.py
Outdated
| if country_iso3alpha: | ||
| reg_id = pycountry.countries.get(alpha_3=country_iso3alpha).numeric |
There was a problem hiding this comment.
In get_litpop_default, there is also a country argument, but it's treated with more tolerance, it can be anything that pycountry.countries.lookup makes sense of, and even a list.
Perhaps the two methods could be aligned with regard to treating countries?
- adjust test_get_exposures for v2 dataset - adjust download faiilure for multi-version datasets - move NoResult error message writing into get_dataset
Add a wrapper function to get centroids from the API
change get_litpop_default() to get_litpop()
add more information to error message when no dataset are found in the wrapper functions
update notebook