Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 8, 2025
1 parent 3e5348a commit e27d058
Show file tree
Hide file tree
Showing 123 changed files with 278 additions and 278 deletions.
2 changes: 1 addition & 1 deletion main/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 518676fa7dfb941c6e17a1b7f416f8f7
config: 88ee47542d76b7bca8f065df8057c533
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified main/.doctrees/adding_features.doctree
Binary file not shown.
Binary file modified main/.doctrees/aggregation.doctree
Binary file not shown.
Binary file modified main/.doctrees/api.doctree
Binary file not shown.
Binary file modified main/.doctrees/build_docs.doctree
Binary file not shown.
Binary file modified main/.doctrees/environment.pickle
Binary file not shown.
Binary file modified main/.doctrees/feature_collection.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/generated/geometric_features.aggregation.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/generated/geometric_features.tag_features.doctree
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/geometric_data.doctree
Binary file not shown.
Binary file modified main/.doctrees/geometric_features.doctree
Binary file not shown.
Binary file modified main/.doctrees/index.doctree
Binary file not shown.
Binary file modified main/.doctrees/quick_start.doctree
Binary file not shown.
32 changes: 16 additions & 16 deletions main/_modules/geometric_features/__main__.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>geometric_features.__main__ &mdash; geometric_features 1.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


Expand Down Expand Up @@ -80,18 +80,18 @@
<div itemprop="articleBody">

<h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">argparse</span>
<span class="kn">import</span> <span class="nn">os</span>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">argparse</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>

<span class="kn">from</span> <span class="nn">geometric_features.feature_collection</span> <span class="kn">import</span> <span class="p">(</span><span class="n">FeatureCollection</span><span class="p">,</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.feature_collection</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span><span class="n">FeatureCollection</span><span class="p">,</span>
<span class="n">read_feature_collection</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">geometric_features.geometric_features</span> <span class="kn">import</span> <span class="n">GeometricFeatures</span>
<span class="kn">from</span> <span class="nn">geometric_features.version</span> <span class="kn">import</span> <span class="n">__version__</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.geometric_features</span><span class="w"> </span><span class="kn">import</span> <span class="n">GeometricFeatures</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span>


<div class="viewcode-block" id="combine_features">
<a class="viewcode-back" href="../../generated/geometric_features.combine_features.html#geometric_features.combine_features">[docs]</a>
<span class="k">def</span> <span class="nf">combine_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">combine_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Entry point for combining features from a file</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -122,7 +122,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="difference_features">
<a class="viewcode-back" href="../../generated/geometric_features.difference_features.html#geometric_features.difference_features">[docs]</a>
<span class="k">def</span> <span class="nf">difference_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">difference_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Entry point for differencing features from a file</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -155,7 +155,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="fix_features_at_antimeridian">
<a class="viewcode-back" href="../../generated/geometric_features.fix_features_at_antimeridian.html#geometric_features.fix_features_at_antimeridian">[docs]</a>
<span class="k">def</span> <span class="nf">fix_features_at_antimeridian</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">fix_features_at_antimeridian</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Entry point for splitting features that cross +/- 180 degrees</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand All @@ -182,7 +182,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="merge_features">
<a class="viewcode-back" href="../../generated/geometric_features.merge_features.html#geometric_features.merge_features">[docs]</a>
<span class="k">def</span> <span class="nf">merge_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">merge_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Entry point for merging features from the geometric_data cache</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -243,7 +243,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="plot_features">
<a class="viewcode-back" href="../../generated/geometric_features.plot_features.html#geometric_features.plot_features">[docs]</a>
<span class="k">def</span> <span class="nf">plot_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">plot_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Entry point for plotting features from a file</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -293,7 +293,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="set_group_name">
<a class="viewcode-back" href="../../generated/geometric_features.set_group_name.html#geometric_features.set_group_name">[docs]</a>
<span class="k">def</span> <span class="nf">set_group_name</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">set_group_name</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set the group name of the feature collection</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -321,7 +321,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="simplify_features">
<a class="viewcode-back" href="../../generated/geometric_features.simplify_features.html#geometric_features.simplify_features">[docs]</a>
<span class="k">def</span> <span class="nf">simplify_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">simplify_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Features in the collection are simplified using ``shapely``</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -352,7 +352,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="split_features">
<a class="viewcode-back" href="../../generated/geometric_features.split_features.html#geometric_features.split_features">[docs]</a>
<span class="k">def</span> <span class="nf">split_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">split_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Features in the collection are split into individual files in the</span>
<span class="sd"> geometric_data cache</span>
Expand Down Expand Up @@ -380,7 +380,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>

<div class="viewcode-block" id="tag_features">
<a class="viewcode-back" href="../../generated/geometric_features.tag_features.html#geometric_features.tag_features">[docs]</a>
<span class="k">def</span> <span class="nf">tag_features</span><span class="p">():</span>
<span class="k">def</span><span class="w"> </span><span class="nf">tag_features</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Features in the collection are tagged with the given tag(s)</span>
<span class="sd"> &quot;&quot;&quot;</span>
Expand Down Expand Up @@ -417,7 +417,7 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>
<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>
<p>&#169; Copyright This software is open source software available under the BSD-3license. Copyright (c) 2025 Triad National Security, LLC. All rights reserved. Copyright (c) 2025 Lawrence Livermore National Security, LLC. All rights reserved. Copyright (c) 2025 UT-Battelle, LLC. All rights reserved..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
18 changes: 9 additions & 9 deletions main/_modules/geometric_features/aggregation.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>geometric_features.aggregation &mdash; geometric_features 1.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />


Expand Down Expand Up @@ -80,21 +80,21 @@
<div itemprop="articleBody">

<h1>Source code for geometric_features.aggregation</h1><div class="highlight"><pre>
<span></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.ocean</span> <span class="kn">import</span> <span class="n">antarctic</span>
<span class="kn">from</span> <span class="nn">geometric_features.aggregation.ocean</span> <span class="kn">import</span> <span class="n">arctic</span> <span class="k">as</span> <span class="n">arctic_ocean</span>
<span class="kn">from</span> <span class="nn">geometric_features.aggregation.ocean</span> <span class="kn">import</span> <span class="p">(</span><span class="n">arctic_transport</span><span class="p">,</span> <span class="n">basins</span><span class="p">,</span>
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.aggregation.landice</span><span class="w"> </span><span class="kn">import</span> <span class="n">nasa_greenland</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.aggregation.ocean</span><span class="w"> </span><span class="kn">import</span> <span class="n">antarctic</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.aggregation.ocean</span><span class="w"> </span><span class="kn">import</span> <span class="n">arctic</span> <span class="k">as</span> <span class="n">arctic_ocean</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">geometric_features.aggregation.ocean</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span><span class="n">arctic_transport</span><span class="p">,</span> <span class="n">basins</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">ismip6_greenland</span><span class="p">,</span> <span class="n">moc</span><span class="p">,</span>
<span class="n">subbasins</span><span class="p">,</span> <span class="n">transport</span><span class="p">)</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="kn">from</span><span class="w"> </span><span class="nn">geometric_features.aggregation.seaice</span><span class="w"> </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="w"> </span><span class="nn">geometric_features.aggregation.seaice</span><span class="w"> </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>
<span class="k">def</span> <span class="nf">get_aggregator_by_name</span><span class="p">(</span><span class="n">region_group</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_aggregator_by_name</span><span class="p">(</span><span class="n">region_group</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get a geojson mask file and the appropriate file suffix for the given</span>
<span class="sd"> region group.</span>
Expand Down Expand Up @@ -184,7 +184,7 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
<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>
<p>&#169; Copyright This software is open source software available under the BSD-3license. Copyright (c) 2025 Triad National Security, LLC. All rights reserved. Copyright (c) 2025 Lawrence Livermore National Security, LLC. All rights reserved. Copyright (c) 2025 UT-Battelle, LLC. All rights reserved..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>geometric_features.aggregation.landice.nasa_greenland_extended &mdash; geometric_features 1.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />


Expand Down Expand Up @@ -83,7 +83,7 @@
<h1>Source code for geometric_features.aggregation.landice.nasa_greenland_extended</h1><div class="highlight"><pre>
<div class="viewcode-block" id="nasa_greenland">
<a class="viewcode-back" href="../../../../generated/geometric_features.aggregation.landice.nasa_greenland.html#geometric_features.aggregation.landice.nasa_greenland">[docs]</a>
<span></span><span class="k">def</span> <span class="nf">nasa_greenland</span><span class="p">(</span><span class="n">gf</span><span class="p">):</span>
<span></span><span class="k">def</span><span class="w"> </span><span class="nf">nasa_greenland</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 NASA Greenland ice sheet basin regions extended to continental</span>
<span class="sd"> shelf.</span>
Expand Down Expand Up @@ -135,7 +135,7 @@ <h1>Source code for geometric_features.aggregation.landice.nasa_greenland_extend
<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>
<p>&#169; Copyright This software is open source software available under the BSD-3license. Copyright (c) 2025 Triad National Security, LLC. All rights reserved. Copyright (c) 2025 Lawrence Livermore National Security, LLC. All rights reserved. Copyright (c) 2025 UT-Battelle, LLC. All rights reserved..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>geometric_features.aggregation.ocean.antarctic_regions &mdash; geometric_features 1.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />


Expand Down Expand Up @@ -83,7 +83,7 @@
<h1>Source code for geometric_features.aggregation.ocean.antarctic_regions</h1><div class="highlight"><pre>
<div class="viewcode-block" id="antarctic">
<a class="viewcode-back" href="../../../../generated/geometric_features.aggregation.ocean.antarctic.html#geometric_features.aggregation.ocean.antarctic">[docs]</a>
<span></span><span class="k">def</span> <span class="nf">antarctic</span><span class="p">(</span><span class="n">gf</span><span class="p">):</span>
<span></span><span class="k">def</span><span class="w"> </span><span class="nf">antarctic</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 Antarctic regions similar to Timmermann et al. (2013)</span>

Expand Down Expand Up @@ -125,7 +125,7 @@ <h1>Source code for geometric_features.aggregation.ocean.antarctic_regions</h1><
<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>
<p>&#169; Copyright This software is open source software available under the BSD-3license. Copyright (c) 2025 Triad National Security, LLC. All rights reserved. Copyright (c) 2025 Lawrence Livermore National Security, LLC. All rights reserved. Copyright (c) 2025 UT-Battelle, LLC. All rights reserved..</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading

0 comments on commit e27d058

Please sign in to comment.