Update Docs

MPAS-Dev · Oct 30, 2024 · dfb89ee · dfb89ee
1 parent d970640
commit dfb89ee
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/aggregation.rst b/docs/aggregation.rst
@@ -25,6 +25,8 @@ the following group names:
 
 * Ocean Subbasins
 
+* Historical Sea Ice
+
 * ISMIP6 Regions
 
 * Transport Transects
@@ -98,6 +100,19 @@ ISMIP6 Greenland Central West Shelf, ISMIP6 Greenland North East Shelf,
 ISMIP6 Greenland North Shelf, ISMIP6 Greenland North West Shelf,
 ISMIP6 Greenland South East Shelf, ISMIP6 Greenland South West Shelf.
 
+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,
+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,
+August Historical Median Sea Ice Extent, September Historical Median Sea Ice Extent,
+October Historical Median Sea Ice Extent, November Historical Median Sea Ice Extent,
+December Historical Median Sea Ice Extent.
+
 Ice-shelf Regions
 ~~~~~~~~~~~~~~~~~
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -100,3 +100,4 @@ Aggregation
 
    aggregation.seaice
    aggregation.seaice.arctic
+   aggregation.seaice.qgreenland
Original file line number	Diff line number	Diff line change
Expand Up		@@ -100,3 +100,4 @@ Aggregation

		aggregation.seaice
		aggregation.seaice.arctic
		aggregation.seaice.qgreenland