Skip to content
Extraits de code Groupes Projets
Valider a57a30b9 rédigé par Benjamin Richaud's avatar Benjamin Richaud
Parcourir les fichiers

Update README.md

parent 35580029
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
......@@ -14,7 +14,7 @@ Check the `test_tbxsectors` notebook for more details.
## Description
Python toolbox to divide polar regions into sectors. Available definitions:
1. Arctic:
- Koenigk et al. (2016)
- Modified Koenigk et al. (2016)
- Årthun et al. (2021)
- NSIDC mask (2023)
2. Antarctic:
......@@ -44,7 +44,7 @@ For a quick use, only the `src/tbxsectors.py` file is necessary, but the NSIDC d
For those wishing to use NSIDC, make sure `xesmf` is installed and download the `data/NSIDCRegions_N3.125km_v1.1_wLatLon_df1.nc` netCDF file containing the NSIDC mask. Set it in your current working directory, or provide the path and name of the file to the `groupby_sectors` function.
## Further details
The Koenigk et al. (2016), Årthun et al. (2021), Zwally et al. (1983) and Raphael & Hobbs (2014) are all based on simple latitude and longitude values, so can be applied with pure pythonic functions and conditions to any grid.
The Koenigk et al. (2016), Årthun et al. (2021), Zwally et al. (1983) and Raphael & Hobbs (2014) are all based on simple latitude and longitude values, so can be applied with pure pythonic functions and conditions to any grid. The original Koenigk et al. (2016) definition contains some overlaps and gaps: those are removed in the provided defintion.
The NSIDC definition is more complexe and doesn't follow meridians or parallels: it is based on a mask provided by the NSIDC (see https://nsidc.org/sites/default/files/documents/technical-reference/nsidc-special-report-25.pdf and https://nsidc.org/data/nsidc-0780/versions/1).
In order to apply this definition, the mask (provided here as `data/NSIDCRegions_N3.125km_v1.1_wLatLon_df1.nc`) needs to be interpolated onto the grid of the user data (hence the use of `xesmf` package), before it can be used.
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter