deploy: c98b776

Deltares · Apr 29, 2024 · d677c2c · d677c2c
1 parent 7b19f0e
commit d677c2c
Show file tree

Hide file tree

Showing 307 changed files with 2,834 additions and 567 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 4c58a4ceab4453c17ef67772dbeeab06
+config: 1864999a6a1df70cb84555637409d055
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/api/xugrid.BarycentricInterpolator.doctree b/.doctrees/api/xugrid.BarycentricInterpolator.doctree
diff --git a/.doctrees/api/xugrid.CentroidLocatorRegridder.doctree b/.doctrees/api/xugrid.CentroidLocatorRegridder.doctree
diff --git a/.doctrees/api/xugrid.OverlapRegridder.doctree b/.doctrees/api/xugrid.OverlapRegridder.doctree
diff --git a/.doctrees/api/xugrid.RelativeOverlapRegridder.doctree b/.doctrees/api/xugrid.RelativeOverlapRegridder.doctree
diff --git a/.doctrees/api/xugrid.Ugrid2d.doctree b/.doctrees/api/xugrid.Ugrid2d.doctree
diff --git a/.doctrees/api/xugrid.Ugrid2d.earcut_triangulate_polygons.doctree b/.doctrees/api/xugrid.Ugrid2d.earcut_triangulate_polygons.doctree
diff --git a/.doctrees/api/xugrid.burn_vector_geometry.doctree b/.doctrees/api/xugrid.burn_vector_geometry.doctree
diff --git a/.doctrees/api/xugrid.earcut_triangulate_polygons.doctree b/.doctrees/api/xugrid.earcut_triangulate_polygons.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples-dev/sg_execution_times.doctree b/.doctrees/examples-dev/sg_execution_times.doctree
diff --git a/.doctrees/examples-dev/voronoi.doctree b/.doctrees/examples-dev/voronoi.doctree
diff --git a/.doctrees/examples/connectivity.doctree b/.doctrees/examples/connectivity.doctree
diff --git a/.doctrees/examples/overlap_regridder.doctree b/.doctrees/examples/overlap_regridder.doctree
diff --git a/.doctrees/examples/partitioning.doctree b/.doctrees/examples/partitioning.doctree
diff --git a/.doctrees/examples/plotting.doctree b/.doctrees/examples/plotting.doctree
diff --git a/.doctrees/examples/quick_overview.doctree b/.doctrees/examples/quick_overview.doctree
diff --git a/.doctrees/examples/regridder_overview.doctree b/.doctrees/examples/regridder_overview.doctree
diff --git a/.doctrees/examples/selection.doctree b/.doctrees/examples/selection.doctree
diff --git a/.doctrees/examples/sg_execution_times.doctree b/.doctrees/examples/sg_execution_times.doctree
diff --git a/.doctrees/examples/vector_conversion.doctree b/.doctrees/examples/vector_conversion.doctree
diff --git a/.doctrees/sample_data/adh_san_diego.doctree b/.doctrees/sample_data/adh_san_diego.doctree
diff --git a/.doctrees/sample_data/disk.doctree b/.doctrees/sample_data/disk.doctree
diff --git a/.doctrees/sample_data/elevation_nl.doctree b/.doctrees/sample_data/elevation_nl.doctree
diff --git a/.doctrees/sample_data/provinces_nl.doctree b/.doctrees/sample_data/provinces_nl.doctree
diff --git a/.doctrees/sample_data/sg_execution_times.doctree b/.doctrees/sample_data/sg_execution_times.doctree
diff --git a/.doctrees/sample_data/xoxo.doctree b/.doctrees/sample_data/xoxo.doctree
diff --git a/.doctrees/sg_execution_times.doctree b/.doctrees/sg_execution_times.doctree
diff --git a/_modules/xugrid/regrid/regridder.html b/_modules/xugrid/regrid/regridder.html
@@ -395,6 +395,7 @@ <h1>Source code for xugrid.regrid.regridder</h1><div class="highlight"><pre>
 
 <span class="kn">import</span> <span class="nn">numba</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
 <span class="kn">import</span> <span class="nn">xarray</span> <span class="k">as</span> <span class="nn">xr</span>
 
 <span class="kn">import</span> <span class="nn">xugrid</span> <span class="k">as</span> <span class="nn">xu</span>
@@ -476,10 +477,12 @@ <h1>Source code for xugrid.regrid.regridder</h1><div class="highlight"><pre>
     <span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_source</span> <span class="o">=</span> <span class="n">setup_grid</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_target</span> <span class="o">=</span> <span class="n">setup_grid</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span> <span class="o">=</span> <span class="kc">None</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_compute_weights</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_source</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="p">)</span>
         <span class="k">return</span>
 
-    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractproperty</span>
+    <span class="nd">@property</span>
+    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
     <span class="k">def</span> <span class="nf">weights</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">pass</span>
 
@@ -632,6 +635,31 @@ <h1>Source code for xugrid.regrid.regridder</h1><div class="highlight"><pre>
         <span class="n">target_ds</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_target</span><span class="o">.</span><span class="n">to_dataset</span><span class="p">(</span><span class="s2">&quot;__target&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">xr</span><span class="o">.</span><span class="n">merge</span><span class="p">((</span><span class="n">weights_ds</span><span class="p">,</span> <span class="n">source_ds</span><span class="p">,</span> <span class="n">target_ds</span><span class="p">))</span>
 
+    <span class="k">def</span> <span class="nf">weights_as_dataframe</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Return the weights as a three column dataframe:</span>
+
+<span class="sd">        * source index</span>
+<span class="sd">        * target index</span>
+<span class="sd">        * weight</span>
+
+<span class="sd">        Returns</span>
+<span class="sd">        -------</span>
+<span class="sd">        weights: pd.DataFrame</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">matrix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span>
+        <span class="k">if</span> <span class="n">matrix</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Weights have not been computed yet.&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">matrix</span><span class="p">,</span> <span class="n">MatrixCSR</span><span class="p">):</span>
+            <span class="n">matrix</span> <span class="o">=</span> <span class="n">matrix</span><span class="o">.</span><span class="n">to_coo</span><span class="p">()</span>
+        <span class="k">return</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
+            <span class="p">{</span>
+                <span class="s2">&quot;target_index&quot;</span><span class="p">:</span> <span class="n">matrix</span><span class="o">.</span><span class="n">row</span><span class="p">,</span>
+                <span class="s2">&quot;source_index&quot;</span><span class="p">:</span> <span class="n">matrix</span><span class="o">.</span><span class="n">col</span><span class="p">,</span>
+                <span class="s2">&quot;weight&quot;</span><span class="p">:</span> <span class="n">matrix</span><span class="o">.</span><span class="n">data</span><span class="p">,</span>
+            <span class="p">}</span>
+        <span class="p">)</span>
+
     <span class="nd">@staticmethod</span>
     <span class="k">def</span> <span class="nf">_csr_from_dataset</span><span class="p">(</span><span class="n">dataset</span><span class="p">:</span> <span class="n">xr</span><span class="o">.</span><span class="n">Dataset</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">MatrixCSR</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>