Skip to content

Commit

Permalink
Deploying to gh-pages from @ 9639f52 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
amoodie committed Dec 18, 2024
1 parent a040882 commit 28ac8e2
Show file tree
Hide file tree
Showing 181 changed files with 2 additions and 2,061 deletions.
2 changes: 1 addition & 1 deletion .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: fe43605d57ebfeffc69915224b02504c
config: d33b7fcca041084a93d5074f0cdab780
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/_autosummary/deltametrics.cube.BaseCube.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.cube.DataCube.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.io.BaseIO.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.io.NetCDFIO.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.BaseMask.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.ChannelMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.DepositMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.EdgeMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.ElevationMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.FlowMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.GeometricMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.LandMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.ShorelineMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.ThresholdValueMask.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.mask.WetMask.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 modified .doctrees/_autosummary/deltametrics.mobility.check_inputs.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.plan.Planform.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 modified .doctrees/_autosummary/deltametrics.plot.VariableInfo.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.plot.VariableSet.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.section.BaseSection.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.section.DipSection.doctree
Binary file not shown.
Binary file modified .doctrees/_autosummary/deltametrics.section.PathSection.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 modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/guides/10min.doctree
Binary file not shown.
Binary file modified .doctrees/guides/devguide.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 modified .doctrees/guides/examples/index.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/io/connect_to_nonstandard_data.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/io/instantiate_mask_directly.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/io/setup_any_dataset.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/plot/show_plan.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/plot/show_section.doctree
Binary file not shown.
Binary file modified .doctrees/guides/examples/plot/simple_movie.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/index.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/mask.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/mobility.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/planform.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/section.doctree
Binary file not shown.
Binary file modified .doctrees/guides/subject_guides/visualization.doctree
Binary file not shown.
Binary file modified .doctrees/guides/userguide.doctree
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file modified .doctrees/meta/conduct.doctree
Binary file not shown.
Binary file modified .doctrees/meta/contributing.doctree
Binary file not shown.
Binary file modified .doctrees/meta/installing.doctree
Binary file not shown.
Binary file modified .doctrees/meta/license.doctree
Binary file not shown.
Binary file modified .doctrees/meta/planning.doctree
Binary file not shown.
Binary file modified .doctrees/reference/cube/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/io/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/mask/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/mobility/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/plan/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/plot/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/sample_data/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/section/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/strat/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/utils/index.doctree
Binary file not shown.
13 changes: 0 additions & 13 deletions _autosummary/deltametrics.cube.BaseCube.html
Original file line number Diff line number Diff line change
Expand Up @@ -358,19 +358,6 @@ <h1>deltametrics.cube.BaseCube<a class="headerlink" href="#deltametrics-cube-bas
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.cube</span> <span class="kn">import</span> <span class="n">StratigraphyCube</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.sample_data.sample_data</span> <span class="kn">import</span> <span class="n">golf</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span> <span class="o">=</span> <span class="n">golf</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span> <span class="o">=</span> <span class="n">StratigraphyCube</span><span class="o">.</span><span class="n">from_DataCube</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">golfcube</span><span class="p">,</span> <span class="n">dz</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="c1"># a Planform (axis=0)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">idx</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="c1"># a DipSection</span>
</pre></div>
</div>
<p>(<a class="reference download internal" download="" href="../_downloads/19729d1ae64f8a3208f5ad06f29361db/deltametrics-cube-BaseCube-1.py"><code class="xref download docutils literal notranslate"><span class="pre">Source</span> <span class="pre">code</span></code></a>, <a class="reference download internal" download="" href="../_downloads/b47ed1d347a90df8ae10287b3a820db2/deltametrics-cube-BaseCube-1.png"><code class="xref download docutils literal notranslate"><span class="pre">png</span></code></a>, <a class="reference download internal" download="" href="../_downloads/baeb04f22ed0fe271e984c539ba23f79/deltametrics-cube-BaseCube-1.hires.png"><code class="xref download docutils literal notranslate"><span class="pre">hires.png</span></code></a>)</p>
<figure class="align-default">
<img alt="../_images/deltametrics-cube-BaseCube-1.png" class="plot-directive" src="../_images/deltametrics-cube-BaseCube-1.png" />
Expand Down
13 changes: 0 additions & 13 deletions _autosummary/deltametrics.cube.DataCube.html
Original file line number Diff line number Diff line change
Expand Up @@ -383,19 +383,6 @@ <h1>deltametrics.cube.DataCube<a class="headerlink" href="#deltametrics-cube-dat
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.cube</span> <span class="kn">import</span> <span class="n">StratigraphyCube</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.sample_data.sample_data</span> <span class="kn">import</span> <span class="n">golf</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span> <span class="o">=</span> <span class="n">golf</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span> <span class="o">=</span> <span class="n">StratigraphyCube</span><span class="o">.</span><span class="n">from_DataCube</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">golfcube</span><span class="p">,</span> <span class="n">dz</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="c1"># a Planform (axis=0)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">idx</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="c1"># a DipSection</span>
</pre></div>
</div>
<p>(<a class="reference download internal" download="" href="../_downloads/0a3b34afe18022c9d8cf2bbd582c92f5/deltametrics-cube-DataCube-1.py"><code class="xref download docutils literal notranslate"><span class="pre">Source</span> <span class="pre">code</span></code></a>, <a class="reference download internal" download="" href="../_downloads/e5d3eb2ce37451da3df81d479da6d476/deltametrics-cube-DataCube-1.png"><code class="xref download docutils literal notranslate"><span class="pre">png</span></code></a>, <a class="reference download internal" download="" href="../_downloads/abbb088fd642ff81623cf90979e28dd3/deltametrics-cube-DataCube-1.hires.png"><code class="xref download docutils literal notranslate"><span class="pre">hires.png</span></code></a>)</p>
<figure class="align-default">
<img alt="../_images/deltametrics-cube-DataCube-1.png" class="plot-directive" src="../_images/deltametrics-cube-DataCube-1.png" />
Expand Down
13 changes: 0 additions & 13 deletions _autosummary/deltametrics.cube.StratigraphyCube.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,19 +411,6 @@ <h1>deltametrics.cube.StratigraphyCube<a class="headerlink" href="#deltametrics-
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.cube</span> <span class="kn">import</span> <span class="n">StratigraphyCube</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.sample_data.sample_data</span> <span class="kn">import</span> <span class="n">golf</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span> <span class="o">=</span> <span class="n">golf</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span> <span class="o">=</span> <span class="n">StratigraphyCube</span><span class="o">.</span><span class="n">from_DataCube</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">golfcube</span><span class="p">,</span> <span class="n">dz</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="c1"># a Planform (axis=0)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfstrat</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">idx</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="c1"># a DipSection</span>
</pre></div>
</div>
<p>(<a class="reference download internal" download="" href="../_downloads/cdd03297af7425b9819afc244a7b7291/deltametrics-cube-StratigraphyCube-1.py"><code class="xref download docutils literal notranslate"><span class="pre">Source</span> <span class="pre">code</span></code></a>, <a class="reference download internal" download="" href="../_downloads/4ed55fe68844b5ff1474cdddde314c7e/deltametrics-cube-StratigraphyCube-1.png"><code class="xref download docutils literal notranslate"><span class="pre">png</span></code></a>, <a class="reference download internal" download="" href="../_downloads/574035569e5eac483d8b03a8b0739d1d/deltametrics-cube-StratigraphyCube-1.hires.png"><code class="xref download docutils literal notranslate"><span class="pre">hires.png</span></code></a>)</p>
<figure class="align-default">
<img alt="../_images/deltametrics-cube-StratigraphyCube-1.png" class="plot-directive" src="../_images/deltametrics-cube-StratigraphyCube-1.png" />
Expand Down
18 changes: 0 additions & 18 deletions _autosummary/deltametrics.mask.CenterlineMask.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,24 +52,6 @@ <h1>deltametrics.mask.CenterlineMask<a class="headerlink" href="#deltametrics-ma
<p>A centerline mask object, provides the location of channel centerlines.</p>
<p class="rubric">Examples</p>
<p>Initialize the <cite>CenterlineMask</cite> from elevation and flow data:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.mask</span> <span class="kn">import</span> <span class="n">CenterlineMask</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">deltametrics.sample_data.sample_data</span> <span class="kn">import</span> <span class="n">golf</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span> <span class="o">=</span> <span class="n">golf</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">cntmsk</span> <span class="o">=</span> <span class="n">CenterlineMask</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">golfcube</span><span class="p">[</span><span class="s1">&#39;eta&#39;</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:],</span>
<span class="gp">... </span> <span class="n">golfcube</span><span class="p">[</span><span class="s1">&#39;velocity&#39;</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="p">:,</span> <span class="p">:],</span>
<span class="gp">... </span> <span class="n">elevation_threshold</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">flow_threshold</span><span class="o">=</span><span class="mf">0.3</span><span class="p">)</span>
</pre></div>
</div>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">8</span><span class="p">,</span> <span class="mi">4</span><span class="p">))</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">golfcube</span><span class="o">.</span><span class="n">quick_show</span><span class="p">(</span><span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="n">idx</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">cntmsk</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="n">ax</span><span class="o">=</span><span class="n">ax</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
</pre></div>
</div>
<p>(<a class="reference download internal" download="" href="../_downloads/721099b3f579e4a6b8ba9abbd0bd2f38/deltametrics-mask-CenterlineMask-1.py"><code class="xref download docutils literal notranslate"><span class="pre">Source</span> <span class="pre">code</span></code></a>, <a class="reference download internal" download="" href="../_downloads/6a7905ec541bdb672d69386673ff8528/deltametrics-mask-CenterlineMask-1.png"><code class="xref download docutils literal notranslate"><span class="pre">png</span></code></a>, <a class="reference download internal" download="" href="../_downloads/c20d6fe392ce883f3bc55ace882aad3d/deltametrics-mask-CenterlineMask-1.hires.png"><code class="xref download docutils literal notranslate"><span class="pre">hires.png</span></code></a>)</p>
<figure class="align-default">
<img alt="../_images/deltametrics-mask-CenterlineMask-1.png" class="plot-directive" src="../_images/deltametrics-mask-CenterlineMask-1.png" />
Expand Down
Loading

0 comments on commit 28ac8e2

Please sign in to comment.