diff --git a/docs/aggregation.rst b/docs/aggregation.rst index 709ffd4f..995d6cc4 100644 --- a/docs/aggregation.rst +++ b/docs/aggregation.rst @@ -119,7 +119,7 @@ Historical Sea Ice The function :py:func:`geometric_features.aggregation.seaice.qgreenland` aggregates the historical monthly median sea ice extents taken from -the QGreenland dataset: January Historical Median Sea Ice Extent, +the QGreenland dataset (doi: doi:10.5281/zenodo.12823307): January Historical Median Sea Ice Extent, February Historical Median Sea Ice Extent, March Historical Median Sea Ice Extent, April Historical Median Sea Ice Extent, May Historical Median Sea Ice Extent, June Historical Median Sea Ice Extent, July Historical Median Sea Ice Extent, diff --git a/geometric_features/aggregation/__init__.py b/geometric_features/aggregation/__init__.py index f724c1d7..df09bf69 100644 --- a/geometric_features/aggregation/__init__.py +++ b/geometric_features/aggregation/__init__.py @@ -1,8 +1,9 @@ from geometric_features.aggregation.ocean import basins, subbasins, \ antarctic, ismip6_greenland, ice_shelves, ismip6, arctic as arctic_ocean, \ transport, arctic_transport, moc -from geometric_features.aggregation.seaice import qgreenland, arctic as arctic_seaice from geometric_features.aggregation.landice import nasa_greenland +from geometric_features.aggregation.seaice import arctic as arctic_seaice +from geometric_features.aggregation.seaice import qgreenland as qgreenland_seaice def get_aggregator_by_name(region_group): """ @@ -65,7 +66,7 @@ def get_aggregator_by_name(region_group): 'function': moc}, 'Historical Sea Ice': {'prefix': 'historicalSeaIce', 'date': '20241018', - 'function': qgreenland}, + 'function': qgreenland_seaice}, 'Transport Transects': {'prefix': 'transportTransects', 'date': '20210323', 'function': transport}, diff --git a/geometric_features/aggregation/seaice/historical_sea_ice.py b/geometric_features/aggregation/seaice/historical_sea_ice.py index b388ded5..2001b118 100644 --- a/geometric_features/aggregation/seaice/historical_sea_ice.py +++ b/geometric_features/aggregation/seaice/historical_sea_ice.py @@ -1,6 +1,8 @@ def qgreenland(gf): """ - Aggregate Greenland continental shelf regions similar to ISMIP6 + Aggregate regions defining median monthly arctic sea ice extent (1981-2010) + from the QGreenland dataset (doi:10.5281/zenodo.12823307). + Parameters ---------- gf : geometric_features.GeometricFeatures diff --git a/geometric_features/geometric_features.py b/geometric_features/geometric_features.py index 060f85da..6cec0e8f 100644 --- a/geometric_features/geometric_features.py +++ b/geometric_features/geometric_features.py @@ -80,7 +80,8 @@ def read(self, componentName, objectType, featureNames=None, tags=None, Parameters ---------- - componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean','seaice'} + componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', + 'natural_earth', 'ocean','seaice'} The component from which to retrieve the geometric features objectType : {'point', 'transect', 'region'} @@ -173,7 +174,8 @@ def _download_geometric_features(self, componentName, objectType, Parameters ---------- - componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean','seaice'} + componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', + 'natural_earth', 'ocean','seaice'} The component from which to retrieve the geometric features objectType : {'point', 'transect', 'region'} @@ -223,7 +225,8 @@ def _get_feature_names(self, componentName, objectType, featureNames, Parameters ---------- - componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean','seaice'} + componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', + 'natural_earth', 'ocean','seaice'} The component from which to retrieve the geometric features objectType : {'point', 'transect', 'region'} @@ -298,7 +301,8 @@ def _get_file_name(componentName, objectType, featureName): Parameters ---------- - componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', 'natural_earth', 'ocean','seaice'} + componentName : {'bedmachine', 'bedmap2', 'iceshelves', 'landice', + 'natural_earth', 'ocean','seaice'} The component from which to retrieve the geometric features objectType : {'point', 'transect', 'region'}