Deploying to gh-pages from @ 574b8b5 🚀

noaa-ocs-modeling · Sep 3, 2024 · 5e56220 · 5e56220
1 parent ae878d0
commit 5e56220
Show file tree

Hide file tree

Showing 14 changed files with 107 additions and 20 deletions.
diff --git a/.buildinfo b/.buildinfo
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.5.9',
+    VERSION: '1.6.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/genindex.html b/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Index &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 
@@ -289,6 +289,8 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="ocsmesh.utilities.html#ocsmesh.utils.delaunay_within">delaunay_within() (in module ocsmesh.utils)</a>
+</li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.drop_extra_vertex_from_line">drop_extra_vertex_from_line() (in module ocsmesh.utils)</a>
 </li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.drop_extra_vertex_from_polygon">drop_extra_vertex_from_polygon() (in module ocsmesh.utils)</a>
@@ -299,14 +301,14 @@ <h2 id="D">D</h2>
         <li><a href="ocsmesh.utilities.html#ocsmesh.raster.Raster.dtype">(ocsmesh.raster.Raster method)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ocsmesh.size_function.html#ocsmesh.hfun.HfunRaster.dtypes">dtypes (ocsmesh.hfun.HfunRaster property)</a>
 
       <ul>
         <li><a href="ocsmesh.utilities.html#ocsmesh.raster.Raster.dtypes">(ocsmesh.raster.Raster property)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ocsmesh.size_function.html#ocsmesh.hfun.HfunRaster.dx">dx (ocsmesh.hfun.HfunRaster property)</a>
 
       <ul>
@@ -897,6 +899,8 @@ <h2 id="S">S</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.shape_to_msh_t_2">shape_to_msh_t_2() (in module ocsmesh.utils)</a>
+</li>
+      <li><a href="ocsmesh.utilities.html#ocsmesh.utils.shptri_to_msht">shptri_to_msht() (in module ocsmesh.utils)</a>
 </li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.sieve">sieve() (in module ocsmesh.utils)</a>
 </li>
@@ -940,15 +944,19 @@ <h2 id="T">T</h2>
       </ul></li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.transform_linestring">transform_linestring() (in module ocsmesh.utils)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ocsmesh.mesh.html#ocsmesh.mesh.EuclideanMesh2D.tria3">tria3 (ocsmesh.mesh.EuclideanMesh2D property)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="ocsmesh.mesh.html#ocsmesh.mesh.EuclideanMesh2D.triangles">triangles (ocsmesh.mesh.EuclideanMesh2D property)</a>
 </li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_polygon">triangulate_polygon() (in module ocsmesh.utils)</a>
 </li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_polygon_s">triangulate_polygon_s() (in module ocsmesh.utils)</a>
+</li>
+      <li><a href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_rivermapper_poly">triangulate_rivermapper_poly() (in module ocsmesh.utils)</a>
+</li>
+      <li><a href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_shp">triangulate_shp() (in module ocsmesh.utils)</a>
 </li>
       <li><a href="ocsmesh.utilities.html#ocsmesh.utils.tricontourf">tricontourf() (in module ocsmesh.utils)</a>
 

diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OCSMesh &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>OCSMesh &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 
@@ -473,6 +473,10 @@ <h1>How to Cite<a class="headerlink" href="#how-to-cite" title="Permalink to thi
 <li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.cleanup_concave_quads"><code class="docutils literal notranslate"><span class="pre">cleanup_concave_quads()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.quadrangulate_rivermapper_arcs"><code class="docutils literal notranslate"><span class="pre">quadrangulate_rivermapper_arcs()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.batched"><code class="docutils literal notranslate"><span class="pre">batched()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.delaunay_within"><code class="docutils literal notranslate"><span class="pre">delaunay_within()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_shp"><code class="docutils literal notranslate"><span class="pre">triangulate_shp()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.shptri_to_msht"><code class="docutils literal notranslate"><span class="pre">shptri_to_msht()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="ocsmesh.utilities.html#ocsmesh.utils.triangulate_rivermapper_poly"><code class="docutils literal notranslate"><span class="pre">triangulate_rivermapper_poly()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="ocsmesh.command_line.html">Command line interface</a><ul>

diff --git a/objects.inv b/objects.inv
diff --git a/ocsmesh.command_line.html b/ocsmesh.command_line.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command line interface &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Command line interface &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/ocsmesh.geometry.html b/ocsmesh.geometry.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Domain definition &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Domain definition &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/ocsmesh.mesh.html b/ocsmesh.mesh.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Mesh representation &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Mesh representation &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/ocsmesh.size_function.html b/ocsmesh.size_function.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Mesh size definition &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Mesh size definition &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/ocsmesh.utilities.html b/ocsmesh.utilities.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Utility classes and functions &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Utility classes and functions &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 
@@ -197,6 +197,10 @@
 <li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.cleanup_concave_quads"><code class="docutils literal notranslate"><span class="pre">cleanup_concave_quads()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.quadrangulate_rivermapper_arcs"><code class="docutils literal notranslate"><span class="pre">quadrangulate_rivermapper_arcs()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.batched"><code class="docutils literal notranslate"><span class="pre">batched()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.delaunay_within"><code class="docutils literal notranslate"><span class="pre">delaunay_within()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.triangulate_shp"><code class="docutils literal notranslate"><span class="pre">triangulate_shp()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.shptri_to_msht"><code class="docutils literal notranslate"><span class="pre">shptri_to_msht()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#ocsmesh.utils.triangulate_rivermapper_poly"><code class="docutils literal notranslate"><span class="pre">triangulate_rivermapper_poly()</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="ocsmesh.command_line.html">Command line interface</a></li>
@@ -2504,6 +2508,81 @@ <h1>Utility classes and functions<a class="headerlink" href="#utility-classes-an
 OCSMesh can run on older with python&lt;3.12</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="ocsmesh.utils.delaunay_within">
+<span class="sig-prename descclassname"><span class="pre">ocsmesh.utils.</span></span><span class="sig-name descname"><span class="pre">delaunay_within</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gdf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ocsmesh.utils.delaunay_within" title="Permalink to this definition"></a></dt>
+<dd><p>Creates  the initial delaunay triangules for 
+a gpd composed of polygons (only).
+Selects those delaunay triangules that fall within domain.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>gdf</strong><span class="classifier">gpd of polygons</span></dt><dd></dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt><strong>gdf</strong><span class="classifier">gpd of triangulated polygons</span></dt><dd></dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="ocsmesh.utils.triangulate_shp">
+<span class="sig-prename descclassname"><span class="pre">ocsmesh.utils.</span></span><span class="sig-name descname"><span class="pre">triangulate_shp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gdf</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ocsmesh.utils.triangulate_shp" title="Permalink to this definition"></a></dt>
+<dd><p>Fills out the gaps left by the delaunay_within</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>gdf</strong><span class="classifier">gpd of polygons</span></dt><dd></dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt><strong>gdf</strong><span class="classifier">gpd of triangulated polygons</span></dt><dd></dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="ocsmesh.utils.shptri_to_msht">
+<span class="sig-prename descclassname"><span class="pre">ocsmesh.utils.</span></span><span class="sig-name descname"><span class="pre">shptri_to_msht</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">triangulated_shp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ocsmesh.utils.shptri_to_msht" title="Permalink to this definition"></a></dt>
+<dd><p>Converts a triangulated shapefile to msh_t</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>triangulated_shp</strong><span class="classifier">triangulated gpd</span></dt><dd></dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>jigsaw_msh_t</dt><dd></dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="ocsmesh.utils.triangulate_rivermapper_poly">
+<span class="sig-prename descclassname"><span class="pre">ocsmesh.utils.</span></span><span class="sig-name descname"><span class="pre">triangulate_rivermapper_poly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rm_poly</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ocsmesh.utils.triangulate_rivermapper_poly" title="Permalink to this definition"></a></dt>
+<dd><p>Creates triangulated mesh using the RiverMapperoutputs</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>rm_poly</strong><span class="classifier">.shp (gpd) file with the RiverMapper outputs</span></dt><dd></dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>jigsaw_msh_t</dt><dd><p>River Mesh</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 </section>
 
 

diff --git a/py-modindex.html b/py-modindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Python Module Index &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/readme.html b/readme.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>OCSMesh &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>OCSMesh &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/search.html b/search.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; ocsmesh 1.5.9 documentation</title>
+  <title>Search &mdash; ocsmesh 1.6.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
 

diff --git a/searchindex.js b/searchindex.js