Update documentation

main/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6c52033aaf103385dae5db162eb8a0a1
+config: 3051ac8bf8f6a317e4e0de30548edaca
 tags: 645f666f9bcd5a90fca523b33c5a78b7

main/_modules/geometric_features/aggregation.html

@@ -83,8 +83,9 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
 <span></span><span class="kn">from</span> <span class="nn">geometric_features.aggregation.ocean</span> <span class="kn">import</span> <span class="n">basins</span><span class="p">,</span> <span class="n">subbasins</span><span class="p">,</span> \
     <span class="n">antarctic</span><span class="p">,</span> <span class="n">ismip6_greenland</span><span class="p">,</span> <span class="n">ice_shelves</span><span class="p">,</span> <span class="n">ismip6</span><span class="p">,</span> <span class="n">arctic</span> <span class="k">as</span> <span class="n">arctic_ocean</span><span class="p">,</span> \
     <span class="n">transport</span><span class="p">,</span> <span class="n">arctic_transport</span><span class="p">,</span> <span class="n">moc</span>
-<span class="kn">from</span> <span class="nn">geometric_features.aggregation.seaice</span> <span class="kn">import</span> <span class="n">arctic</span> <span class="k">as</span> <span class="n">arctic_seaice</span>
 <span class="kn">from</span> <span class="nn">geometric_features.aggregation.landice</span> <span class="kn">import</span> <span class="n">nasa_greenland</span>
+<span class="kn">from</span> <span class="nn">geometric_features.aggregation.seaice</span> <span class="kn">import</span> <span class="n">arctic</span> <span class="k">as</span> <span class="n">arctic_seaice</span>
+<span class="kn">from</span> <span class="nn">geometric_features.aggregation.seaice</span> <span class="kn">import</span> <span class="n">qgreenland</span> <span class="k">as</span> <span class="n">qgreenland_seaice</span>
 
 <div class="viewcode-block" id="get_aggregator_by_name">
 <a class="viewcode-back" href="../../generated/geometric_features.aggregation.get_aggregator_by_name.html#geometric_features.aggregation.get_aggregator_by_name">[docs]</a>
@@ -147,6 +148,9 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
                <span class="s1">&#39;MOC Basins&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;prefix&#39;</span><span class="p">:</span> <span class="s1">&#39;mocBasins&#39;</span><span class="p">,</span>
                               <span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20210623&#39;</span><span class="p">,</span>
                               <span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">moc</span><span class="p">},</span>
+               <span class="s1">&#39;Historical Sea Ice&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;prefix&#39;</span><span class="p">:</span> <span class="s1">&#39;historicalSeaIce&#39;</span><span class="p">,</span>
+                                      <span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20241018&#39;</span><span class="p">,</span>
+                                      <span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">qgreenland_seaice</span><span class="p">},</span>
                <span class="s1">&#39;Transport Transects&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s1">&#39;prefix&#39;</span><span class="p">:</span> <span class="s1">&#39;transportTransects&#39;</span><span class="p">,</span>
                                        <span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20210323&#39;</span><span class="p">,</span>
                                        <span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">transport</span><span class="p">},</span>

main/_modules/geometric_features/aggregation/seaice/historical_sea_ice.html

@@ -0,0 +1,184 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>geometric_features.aggregation.seaice.historical_sea_ice &mdash; geometric_features 1.5.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
+
+
+      <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../../../_static/documentation_options.js?v=e0a75244"></script>
+      <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../../search.html" />
+    <link href="../../../../_static/style.css" rel="stylesheet" type="text/css">
+
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../../index.html" class="icon icon-home">
+            geometric_features
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">User's Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../geometric_features.html">GeometricFeatures</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../feature_collection.html">FeatureCollection</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../geometric_data.html">Geometric Data</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../aggregation.html">Aggregate Existing Features</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Developer's Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../adding_features.html">Adding New Features</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../build_docs.html">Building the Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">API reference</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../../index.html">geometric_features</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+          <li class="breadcrumb-item"><a href="../../aggregation.html">geometric_features.aggregation</a></li>
+      <li class="breadcrumb-item active">geometric_features.aggregation.seaice.historical_sea_ice</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for geometric_features.aggregation.seaice.historical_sea_ice</h1><div class="highlight"><pre>
+<div class="viewcode-block" id="qgreenland">
+<a class="viewcode-back" href="../../../../generated/geometric_features.aggregation.seaice.qgreenland.html#geometric_features.aggregation.seaice.qgreenland">[docs]</a>
+<span></span><span class="k">def</span> <span class="nf">qgreenland</span><span class="p">(</span><span class="n">gf</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Aggregate regions defining median monthly arctic sea ice extent (1981-2010)</span>
+<span class="sd">    from the QGreenland dataset (doi:10.5281/zenodo.12823307).</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    gf : geometric_features.GeometricFeatures</span>
+<span class="sd">        An object that knows how to download and read geometric features</span>
+<span class="sd">    Returns</span>
+<span class="sd">    -------</span>
+<span class="sd">    fc : geometric_features.FeatureCollection</span>
+<span class="sd">        The new feature collection with antarctic regions</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="c1"># Authors</span>
+    <span class="c1"># -------</span>
+    <span class="c1"># Alex Hager</span>
+
+    <span class="n">regions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;April Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;August Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;December Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;February Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;January Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;July Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;June Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;March Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;May Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;November Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;October Historical Median Sea Ice Extent&#39;</span><span class="p">,</span>
+               <span class="s1">&#39;September Historical Median Sea Ice Extent&#39;</span>
+              <span class="p">]</span>
+    <span class="n">fc</span> <span class="o">=</span> <span class="n">gf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">componentName</span><span class="o">=</span><span class="s1">&#39;seaice&#39;</span><span class="p">,</span> <span class="n">objectType</span><span class="o">=</span><span class="s1">&#39;region&#39;</span><span class="p">,</span>
+                 <span class="n">featureNames</span><span class="o">=</span><span class="n">regions</span><span class="p">)</span>
+
+    <span class="k">return</span> <span class="n">fc</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright This software is open source software available under the BSD-3license. Copyright (c) 2024 Triad National Security, LLC. All rights reserved. Copyright (c) 2024 Lawrence Livermore National Security, LLC. All rights reserved. Copyright (c) 2024 UT-Battelle, LLC. All rights reserved..</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+
+<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    <span class="fa fa-book"> Other Versions</span>
+    v: main
+    <span class="fa fa-caret-down"></span>
+  </span>
+  <div class="rst-other-versions">
+    <dl>
+      <dt>Tags</dt>
+      <dd><a href="../../../../../0.1.12/index.html">0.1.12</a></dd>
+      <dd><a href="../../../../../0.1.13/index.html">0.1.13</a></dd>
+      <dd><a href="../../../../../0.2.0/index.html">0.2.0</a></dd>
+      <dd><a href="../../../../../0.3.0/index.html">0.3.0</a></dd>
+      <dd><a href="../../../../../0.4.0/index.html">0.4.0</a></dd>
+      <dd><a href="../../../../../0.5.0/index.html">0.5.0</a></dd>
+      <dd><a href="../../../../../0.6.0/index.html">0.6.0</a></dd>
+      <dd><a href="../../../../../0.7.0/index.html">0.7.0</a></dd>
+      <dd><a href="../../../../../0.8.0/index.html">0.8.0</a></dd>
+      <dd><a href="../../../../../1.0.0/index.html">1.0.0</a></dd>
+      <dd><a href="../../../../../1.0.1/index.html">1.0.1</a></dd>
+      <dd><a href="../../../../../1.1.0/index.html">1.1.0</a></dd>
+      <dd><a href="../../../../../1.2.0/index.html">1.2.0</a></dd>
+      <dd><a href="../../../../../1.3.0/index.html">1.3.0</a></dd>
+      <dd><a href="../../../../../1.4.0/index.html">1.4.0</a></dd>
+      <dd><a href="../../../../../1.5.0/index.html">1.5.0</a></dd>
+    </dl>
+    <dl>
+      <dt>Branches</dt>
+      <dd><a href="historical_sea_ice.html">main</a></dd>
+    </dl>
+  </div>
+</div>
+<script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>

main/_modules/geometric_features/geometric_features.html

@@ -169,7 +169,8 @@ <h1>Source code for geometric_features.geometric_features</h1><div class="highli
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, &#39;natural_earth&#39;, &#39;ocean&#39;}</span>
+<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, </span>
+<span class="sd">        &#39;natural_earth&#39;, &#39;ocean&#39;,&#39;seaice&#39;}</span>
 <span class="sd">            The component from which to retrieve the geometric features</span>
 
 <span class="sd">        objectType : {&#39;point&#39;, &#39;transect&#39;, &#39;region&#39;}</span>
@@ -266,7 +267,8 @@ <h1>Source code for geometric_features.geometric_features</h1><div class="highli
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, &#39;natural_earth&#39;, &#39;ocean&#39;}</span>
+<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, </span>
+<span class="sd">        &#39;natural_earth&#39;, &#39;ocean&#39;,&#39;seaice&#39;}</span>
 <span class="sd">            The component from which to retrieve the geometric features</span>
 
 <span class="sd">        objectType : {&#39;point&#39;, &#39;transect&#39;, &#39;region&#39;}</span>
@@ -316,7 +318,8 @@ <h1>Source code for geometric_features.geometric_features</h1><div class="highli
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, &#39;natural_earth&#39;, &#39;ocean&#39;}</span>
+<span class="sd">        componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, </span>
+<span class="sd">        &#39;natural_earth&#39;, &#39;ocean&#39;,&#39;seaice&#39;}</span>
 <span class="sd">            The component from which to retrieve the geometric features</span>
 
 <span class="sd">        objectType : {&#39;point&#39;, &#39;transect&#39;, &#39;region&#39;}</span>
@@ -392,7 +395,8 @@ <h1>Source code for geometric_features.geometric_features</h1><div class="highli
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
-<span class="sd">    componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, &#39;natural_earth&#39;, &#39;ocean&#39;}</span>
+<span class="sd">    componentName : {&#39;bedmachine&#39;, &#39;bedmap2&#39;, &#39;iceshelves&#39;, &#39;landice&#39;, </span>
+<span class="sd">    &#39;natural_earth&#39;, &#39;ocean&#39;,&#39;seaice&#39;}</span>
 <span class="sd">        The component from which to retrieve the geometric features</span>
 
 <span class="sd">    objectType : {&#39;point&#39;, &#39;transect&#39;, &#39;region&#39;}</span>

main/_modules/index.html

@@ -91,6 +91,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="geometric_features/aggregation/ocean/subbasin_regions.html">geometric_features.aggregation.ocean.subbasin_regions</a></li>
 <li><a href="geometric_features/aggregation/ocean/transport_transects.html">geometric_features.aggregation.ocean.transport_transects</a></li>
 <li><a href="geometric_features/aggregation/seaice/arctic_regions.html">geometric_features.aggregation.seaice.arctic_regions</a></li>
+<li><a href="geometric_features/aggregation/seaice/historical_sea_ice.html">geometric_features.aggregation.seaice.historical_sea_ice</a></li>
 </ul><li><a href="geometric_features/feature_collection.html">geometric_features.feature_collection</a></li>
 <li><a href="geometric_features/geometric_features.html">geometric_features.geometric_features</a></li>
 <li><a href="geometric_features/utils.html">geometric_features.utils</a></li>

main/_sources/aggregation.rst.txt

@@ -27,6 +27,8 @@ the following group names:
 
 * Ocean Subbasins
 
+* Historical Sea Ice
+
 * ISMIP6 Regions
 
 * Transport Transects
@@ -112,6 +114,19 @@ have also been altered so that all glaciers terminating in an individual fjord
 are from the same drainage basin. Regions cover both landice and ocean, and could be used for either
 component.
 
+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 (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,
+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
 ~~~~~~~~~~~~~~~~~
 

main/_sources/api.rst.txt

@@ -100,5 +100,5 @@ Aggregation
 
    aggregation.seaice
    aggregation.seaice.arctic
-
+   aggregation.seaice.qgreenland
    aggregation.landice.nasa_greenland

main/_sources/generated/geometric_features.aggregation.seaice.qgreenland.rst.txt

@@ -0,0 +1,6 @@
+geometric\_features.aggregation.seaice.qgreenland
+=================================================
+
+.. currentmodule:: geometric_features.aggregation.seaice
+
+.. autofunction:: qgreenland