Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions mkdocs/docs/packages/evo-compute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ params = KrigingParameters(
source=pointset.attributes["grade"],
target=block_model.attributes["kriged_grade"], # Creates if new, updates if exists
variogram=variogram,
search=SearchNeighborhood(
neighborhood=SearchNeighborhood(
ellipsoid=Ellipsoid(ranges=EllipsoidRanges(200, 150, 100)),
max_samples=20,
),
Expand All @@ -40,13 +40,13 @@ results = await run(manager, [
source=pointset.attributes["Au"],
target=block_model.attributes["Au_kriged"],
variogram=au_variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
),
KrigingParameters(
source=pointset.attributes["Cu"],
target=block_model.attributes["Cu_kriged"],
variogram=cu_variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
),
], preview=True)

Expand Down Expand Up @@ -94,7 +94,7 @@ first_result = await run(manager, KrigingParameters(
source=pointset.attributes["grade"],
target=block_model.attributes["kriged_grade"],
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes["domain"],
Expand All @@ -113,7 +113,7 @@ results = await run(manager, [
source=pointset.attributes["grade"],
target=block_model.attributes["kriged_grade"], # Exists → update
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes["domain"],
Expand All @@ -126,7 +126,7 @@ results = await run(manager, [
source=pointset.attributes["grade"],
target=block_model.attributes["kriged_grade"], # Exists → update
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes["domain"],
Expand Down
12 changes: 6 additions & 6 deletions mkdocs/site/packages/evo-compute/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3 id="single-task">Single task</h3>
source=pointset.attributes[&quot;grade&quot;],
target=block_model.attributes[&quot;kriged_grade&quot;], # Creates if new, updates if exists
variogram=variogram,
search=SearchNeighborhood(
neighborhood=SearchNeighborhood(
ellipsoid=Ellipsoid(ranges=EllipsoidRanges(200, 150, 100)),
max_samples=20,
),
Expand All @@ -109,13 +109,13 @@ <h3 id="multiple-tasks">Multiple tasks</h3>
source=pointset.attributes[&quot;Au&quot;],
target=block_model.attributes[&quot;Au_kriged&quot;],
variogram=au_variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
),
KrigingParameters(
source=pointset.attributes[&quot;Cu&quot;],
target=block_model.attributes[&quot;Cu_kriged&quot;],
variogram=cu_variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
),
], preview=True)

Expand Down Expand Up @@ -152,7 +152,7 @@ <h3 id="how-do-i-run-parallel-tasks-that-update-the-same-attribute">How do I run
source=pointset.attributes[&quot;grade&quot;],
target=block_model.attributes[&quot;kriged_grade&quot;],
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes[&quot;domain&quot;],
Expand All @@ -171,7 +171,7 @@ <h3 id="how-do-i-run-parallel-tasks-that-update-the-same-attribute">How do I run
source=pointset.attributes[&quot;grade&quot;],
target=block_model.attributes[&quot;kriged_grade&quot;], # Exists → update
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes[&quot;domain&quot;],
Expand All @@ -184,7 +184,7 @@ <h3 id="how-do-i-run-parallel-tasks-that-update-the-same-attribute">How do I run
source=pointset.attributes[&quot;grade&quot;],
target=block_model.attributes[&quot;kriged_grade&quot;], # Exists → update
variogram=variogram,
search=SearchNeighborhood(...),
neighborhood=SearchNeighborhood(...),
target_filter=Filter(
where=FilterCondition(
attribute=block_model.attributes[&quot;domain&quot;],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,19 +100,19 @@ <h2 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters" class="doc do
... source=pointset.attributes["grade"], # Source attribute
... target=block_model.attributes["kriged_grade"], # Target attribute (creates if doesn't exist)
... variogram=variogram, # Variogram model
... search=SearchNeighborhood(
... neighborhood=SearchNeighborhood(
... ellipsoid=Ellipsoid(ranges=EllipsoidRanges(200, 150, 100)),
... max_samples=20,
... ),
... # method defaults to ordinary kriging
... # kriging_method defaults to ordinary kriging
... )
&gt;&gt;&gt;
&gt;&gt;&gt; # With a target filter to restrict kriging to specific categories on the target:
&gt;&gt;&gt; params_filtered = KrigingParameters(
... source=pointset.attributes["grade"],
... target=block_model.attributes["kriged_grade"],
... variogram=variogram,
... search=SearchNeighborhood(...),
... neighborhood=SearchNeighborhood(...),
... target_filter=Filter(
... where=FilterCondition(
... attribute=block_model.attributes["domain"],
Expand All @@ -127,7 +127,7 @@ <h2 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters" class="doc do
... source=pointset.attributes["grade"],
... target=block_model.attributes["kriged_grade"],
... variogram=variogram,
... search=SearchNeighborhood(...),
... neighborhood=SearchNeighborhood(...),
... diagnostics=KrigingDiagnostics(kriging_variance=True, num_samples=True),
... )
</code></pre>
Expand Down Expand Up @@ -214,17 +214,59 @@ <h3 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters.variogram" cla



<h3 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters.neighborhood" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">neighborhood</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">neighborhood</span><span class="p">:</span> <span class="n">SearchNeighborhood</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">validation_alias</span><span class="o">=</span><span class="n">AliasChoices</span><span class="p">(</span><span class="s1">&#39;neighborhood&#39;</span><span class="p">,</span> <span class="s1">&#39;search&#39;</span><span class="p">))</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Search neighborhood parameters.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters.kriging_method" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">kriging_method</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">kriging_method</span><span class="p">:</span> <span class="n">SimpleKriging</span> <span class="o">|</span> <span class="n">OrdinaryKriging</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
<span class="n">default_factory</span><span class="o">=</span><span class="n">OrdinaryKriging</span><span class="p">,</span> <span class="n">validation_alias</span><span class="o">=</span><span class="n">AliasChoices</span><span class="p">(</span><span class="s2">&quot;kriging_method&quot;</span><span class="p">,</span> <span class="s2">&quot;method&quot;</span><span class="p">)</span>
<span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The kriging method to use. Defaults to ordinary kriging if not specified.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters.search" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">search</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">search</span><span class="p">:</span> <span class="n">SearchNeighborhood</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">alias</span><span class="o">=</span><span class="s1">&#39;neighborhood&#39;</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">search</span><span class="p">:</span> <span class="n">SearchNeighborhood</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Search neighborhood parameters.</p>
<p>Backwards-compatible alias for :attr:<code>neighborhood</code>.</p>

</div>

Expand All @@ -239,12 +281,12 @@ <h3 id="evo.compute.tasks.geostatistics.kriging.KrigingParameters.method" class=


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">method</span><span class="p">:</span> <span class="n">SimpleKriging</span> <span class="o">|</span> <span class="n">OrdinaryKriging</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="n">OrdinaryKriging</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="s1">&#39;kriging_method&#39;</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">method</span><span class="p">:</span> <span class="n">SimpleKriging</span> <span class="o">|</span> <span class="n">OrdinaryKriging</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The kriging method to use. Defaults to ordinary kriging if not specified.</p>
<p>Backwards-compatible alias for :attr:<code>kriging_method</code>.</p>

</div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,24 +95,27 @@ <h2 id="evo.compute.tasks.common.search.SearchNeighborhood" class="doc doc-headi
<p>The search neighborhood is defined by an ellipsoid (spatial extent and
orientation) and constraints on the number of samples to use.</p>
<p>Kriging, IDW, KNN and declustering can further limit the samples by octant,
quadrant and drillhole. The other tasks do not support these limits and
quadrant and drillhole (<code>max_samples_per_drillhole</code> and <code>max_drillholes</code>).
Kriging additionally supports <code>min_drillholes</code> and non-global
<code>drillhole_limit_scope</code>. The other tasks do not support these limits and
refuse a neighborhood that sets them.</p>
<p>Example::</p>
<pre><code>&gt;&gt;&gt; search = SearchNeighborhood(
... ellipsoid=Ellipsoid(
... ranges=EllipsoidRanges(major=200.0, semi_major=150.0, minor=100.0),
... rotation=Rotation(dip_azimuth=45.0),
... rotation=Rotation(dip_azimuth=45.0, dip=0.0, pitch=0.0),
... ),
... max_samples=20,
... )
&gt;&gt;&gt;
&gt;&gt;&gt; # Octant search, using at most 3 samples from each drillhole:
&gt;&gt;&gt; # Octant search, using at most 3 samples from each drillhole across at most 6 drillholes:
&gt;&gt;&gt; search = SearchNeighborhood(
... ellipsoid=Ellipsoid(ranges=EllipsoidRanges(major=200.0, semi_major=150.0, minor=100.0)),
... max_samples=24,
... max_samples_per_octant=3,
... max_empty_octants=4,
... max_samples_per_drillhole=3,
... max_drillholes=6,
... )
</code></pre>

Expand Down Expand Up @@ -143,7 +146,12 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.ellipsoid" class="doc


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">ellipsoid</span><span class="p">:</span> <span class="n">Ellipsoid</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">ellipsoid</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
<span class="n">Ellipsoid</span><span class="p">,</span>
<span class="n">PlainValidator</span><span class="p">(</span><span class="n">_validate_ellipsoid</span><span class="p">),</span>
<span class="n">PlainSerializer</span><span class="p">(</span><span class="n">_serialize_ellipsoid</span><span class="p">),</span>
<span class="n">WithJsonSchema</span><span class="p">(</span><span class="n">_ELLIPSOID_JSON_SCHEMA</span><span class="p">),</span>
<span class="p">]</span>
</code></pre></div>

<div class="doc doc-contents ">
Expand Down Expand Up @@ -301,17 +309,87 @@ <h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_samples_per_drill



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_drillholes</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_drillholes</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
<span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">validation_alias</span><span class="o">=</span><span class="n">AliasChoices</span><span class="p">(</span><span class="s2">&quot;max_drillholes&quot;</span><span class="p">,</span> <span class="s2">&quot;max_drillholes_per_estimate&quot;</span><span class="p">)</span>
<span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The maximum number of drillholes used in each estimate. Requires a downhole intervals source object.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.min_drillholes" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">min_drillholes</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">min_drillholes</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span>
<span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">validation_alias</span><span class="o">=</span><span class="n">AliasChoices</span><span class="p">(</span><span class="s2">&quot;min_drillholes&quot;</span><span class="p">,</span> <span class="s2">&quot;min_drillholes_per_estimate&quot;</span><span class="p">)</span>
<span class="p">)</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The minimum number of distinct drillholes required per estimate.</p>
<p>Omitted (disabled) when <code>None</code> or <code>0</code>. Currently supported only by kriging
and requires a downhole intervals source object.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.drillhole_limit_scope" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">drillhole_limit_scope</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">drillhole_limit_scope</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;global&#39;</span><span class="p">,</span> <span class="s1">&#39;quadrant&#39;</span><span class="p">,</span> <span class="s1">&#39;octant&#39;</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Scope at which <code>max_samples_per_drillhole</code> is applied.</p>
<p><code>"global"</code> (or <code>None</code>) applies <code>max_samples_per_drillhole</code> across the whole
neighborhood and is omitted on the wire. <code>"quadrant"</code> and <code>"octant"</code> apply
<code>max_samples_per_drillhole</code> within each sector, require <code>max_samples_per_drillhole</code>
to be set, and are currently supported only by kriging.</p>

</div>

</div>

<div class="doc doc-object doc-attribute">



<h3 id="evo.compute.tasks.common.search.SearchNeighborhood.max_drillholes_per_estimate" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">max_drillholes_per_estimate</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_drillholes_per_estimate</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ge</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">max_drillholes_per_estimate</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>The maximum number of drillholes used in each estimate. Requires a downhole intervals source object.</p>
<p>Backwards-compatible alias for :attr:<code>max_drillholes</code>.</p>

</div>

Expand Down
8 changes: 4 additions & 4 deletions packages/evo-compute/docs/examples/kriging.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,12 @@
"outputs": [],
"source": [
"# Create kriging parameters\n",
"# Note: method defaults to ordinary kriging, so we don't need to specify it\n",
"# Note: kriging_method defaults to ordinary kriging, so we don't need to specify it\n",
"kriging_params = KrigingParameters(\n",
" source=source_pointset.attributes[\"Ag_ppm Values\"],\n",
" target=target_grid.attributes[\"kriged_grade 5\"],\n",
" variogram=variogram,\n",
" search=SearchNeighborhood(\n",
" neighborhood=SearchNeighborhood(\n",
" ellipsoid=search_ellipsoid,\n",
" max_samples=20,\n",
" ),\n",
Expand Down Expand Up @@ -285,7 +285,7 @@
" source=source_pointset.attributes[\"Ag_ppm Values\"],\n",
" target=target_grid.attributes[\"kriged_grade_diagnostics\"],\n",
" variogram=variogram,\n",
" search=SearchNeighborhood(\n",
" neighborhood=SearchNeighborhood(\n",
" ellipsoid=search_ellipsoid,\n",
" max_samples=20,\n",
" ),\n",
Expand Down Expand Up @@ -599,7 +599,7 @@
" source=source_pointset_created.locations.attributes[\"elevation\"],\n",
" target=Target.new_attribute(target_grid_created, attribute_name=\"kriged_elevation2\"),\n",
" variogram=variogram_created,\n",
" search=SearchNeighborhood(\n",
" neighborhood=SearchNeighborhood(\n",
" ellipsoid=Ellipsoid(\n",
" ranges=EllipsoidRanges(major=134.0, semi_major=90.0, minor=40.0),\n",
" rotation=Rotation(dip_azimuth=100.0, dip=65.0, pitch=75.0),\n",
Expand Down
Loading
Loading