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 Dec 21, 2024
1 parent 6b742e2 commit 8e0bbf6
Show file tree
Hide file tree
Showing 122 changed files with 52 additions and 1,459 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: ef700b6104f320932243db824bc59b2a
config: 12eb901b4d322b78ac58645ca4e63eec
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.
50 changes: 14 additions & 36 deletions main/_modules/geometric_features/__main__.html

Large diffs are not rendered by default.

32 changes: 6 additions & 26 deletions main/_modules/geometric_features/aggregation.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,11 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20201123&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">subbasins</span><span class="p">},</span>
<span class="s1">&#39;ISMIP6 Greenland Regions&#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;ismip6GreenlandRegions&#39;</span><span class="p">,</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20240510&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">ismip6_greenland</span><span class="p">},</span>
<span class="s1">&#39;NASA Greenland Regions&#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;nasaGreenlandRegions&#39;</span><span class="p">,</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span><span class="s1">&#39;20241017&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">nasa_greenland</span><span class="p">},</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20240510&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">ismip6_greenland</span><span class="p">},</span>
<span class="s1">&#39;NASA Greenland Regions&#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;nasaGreenlandRegions&#39;</span><span class="p">,</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20241017&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">nasa_greenland</span><span class="p">},</span>
<span class="s1">&#39;ISMIP6 Regions&#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;ismip6Regions&#39;</span><span class="p">,</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20210201&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">ismip6</span><span class="p">},</span>
Expand All @@ -159,7 +159,7 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
<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>
<span class="s1">&#39;Arctic 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;arcticTransportTransects&#39;</span><span class="p">,</span>
<span class="s1">&#39;Arctic 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;arcticTransportTransects&#39;</span><span class="p">,</span> <span class="c1"># noqa: E501</span>
<span class="s1">&#39;date&#39;</span><span class="p">:</span> <span class="s1">&#39;20220926&#39;</span><span class="p">,</span>
<span class="s1">&#39;function&#39;</span><span class="p">:</span> <span class="n">arctic_transport</span><span class="p">}}</span>

Expand Down Expand Up @@ -205,26 +205,6 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
<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>
<dd><a href="../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="aggregation.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ <h1>Source code for geometric_features.aggregation.landice.nasa_greenland_extend
<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 class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Aggregate NASA Greenland ice sheet basin regions extended to continental shelf.</span>
<span class="sd"> Aggregate NASA Greenland ice sheet basin regions extended to continental</span>
<span class="sd"> shelf.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
Expand Down Expand Up @@ -155,26 +156,6 @@ <h1>Source code for geometric_features.aggregation.landice.nasa_greenland_extend
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="nasa_greenland_extended.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,26 +146,6 @@ <h1>Source code for geometric_features.aggregation.ocean.antarctic_regions</h1><
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="antarctic_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,26 +145,6 @@ <h1>Source code for geometric_features.aggregation.ocean.arctic_regions</h1><div
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="arctic_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,26 +285,6 @@ <h1>Source code for geometric_features.aggregation.ocean.ice_shelf_regions</h1><
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ice_shelf_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,26 +144,6 @@ <h1>Source code for geometric_features.aggregation.ocean.ismip6_greenland_region
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ismip6_greenland_regions.html">main</a></dd>
Expand Down
20 changes: 0 additions & 20 deletions main/_modules/geometric_features/aggregation/ocean/moc_basins.html
Original file line number Diff line number Diff line change
Expand Up @@ -237,26 +237,6 @@ <h1>Source code for geometric_features.aggregation.ocean.moc_basins</h1><div cla
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="moc_basins.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,26 +164,6 @@ <h1>Source code for geometric_features.aggregation.ocean.ocean_basins</h1><div c
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ocean_basins.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -353,26 +353,6 @@ <h1>Source code for geometric_features.aggregation.ocean.subbasin_regions</h1><d
<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>
<dd><a href="../../../../../1.6.0/index.html">1.6.0</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="subbasin_regions.html">main</a></dd>
Expand Down
Loading

0 comments on commit 8e0bbf6

Please sign in to comment.