feat(config): update zones .yaml + zone pydantic model to include region and country #6856
Conversation
github-actions
bot
added
python
I will make a new commit today to try and fix the indentation :) I am not sure if it is breaking, but I still dislike that this PR changes 40.000 lines of code. And regarding the merge, I am in no hurry, but thanks for checking it so fast! |
Indentation should already be fixed 😉 |
| value: 0.94 | ||
| isRenewable: | ||
| unknown: | ||
| - datetime: '2019-01-01' | ||
| source: 'assumes 87% hydro, 5% biomass, 4% gas, 2% wind and 2% from various sources' |
There was a problem hiding this comment.
Are these changes okay? Is it due to the formatting? @VIKTORVAV99
There was a problem hiding this comment.
Perfectly fine, as long as it passes prettier it's good to go.
config/zones/NA.yaml
Outdated
| @@ -77,3 +77,5 @@ fallbackZoneMixes: | |||
| unknown: 0.0 | |||
| wind: 0.015505325244864603 | |||
| timezone: Africa/Windhoek | |||
| region: Africa | |||
| country: null | |||
There was a problem hiding this comment.
I decided to use null instead of Other for zones with an ambiguous country. It might potentially be a sensitive topic, so I thought it was the most appropriate to leave the value as null in these cases. Please bring other suggestions if you have any!
There was a problem hiding this comment.
I think that's a nice approach but this is Namibia and as far as I know it's not contested?
There was a problem hiding this comment.
Oh, you're right, good catch! I don't know how that snuck a null value there, but i'll update it to the correct value. Appreciate the nice check :)
| timezone: America/Nuuk | ||
| region: Americas | ||
| country: GL |
There was a problem hiding this comment.
As a fellow dane I am very disappointed in you on this one 😉 🇬🇱
There was a problem hiding this comment.
Oh don't you start or we'll have a mess on our hands with all these overseas territories... 😅
There was a problem hiding this comment.
I used the ISO-3166-1 (https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv) standard to generate the configs, but it hurts my danish heart 😭
Issue
There is currently no clear source-of-truth for regions and countries of zones.
Description
regionandcountryattribute in the pydantic config modelregionandcountrykeys across all .yaml zone configurationsNotes on data sources
All regions and countries are following the ISO-3166 standard with values taken from here: https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv
We want to use these new attributes for aggregation and grouping of our zones. It was also considered if this could be done using existing information, and I checked the subZoneNames. We do have the field
sub_zone_names: list[ZoneKey] | None = Field(None, alias="subZoneNames")in our zone model, which indicates aparent_zoneandsub_zonerelation. However, this is not populated exhaustively across all configurations to be used instead of acountryattribute.Preview
An example of a US zone including
countryandregionDouble check
poetry run test_parser "zone_key"pnpx prettier@2 --write .andpoetry run formatin the top level directory to format my changes.