Skip to content
Open
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
3 changes: 3 additions & 0 deletions .github/workflows/mkdocs-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ jobs:
run: |
uv run mkdocs build --config-file mkdocs/mkdocs.yml --site-dir site

- name: Include new generated pages in the documentation diff
run: git add --intent-to-add mkdocs

- name: Check for changes
id: changes
run: |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-blockmodels/src/evo/blockmodels/typed/report.py)
::: evo.blockmodels.typed.report.ReportCell
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-blockmodels/src/evo/blockmodels/typed/report.py)
::: evo.blockmodels.typed.report.ReportCellStatus
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationEstimator
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationOutputs
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationParameters
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationResult
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationResultModel
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationRunner
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationSource
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationSourceResult
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.CrossValidationStatistics
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.IDWEstimator
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.KNNEstimator
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.KrigingCrossValidationStatistics
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.KrigingEstimator
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.LeaveOneDrillholeOut
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.LeaveOneSampleOut
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/cross_validation.py)
::: evo.compute.tasks.geostatistics.cross_validation.ValidationStrategy
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py)
::: evo.compute.tasks.geostatistics.kriging.KrigingDiagnostics
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py)
::: evo.compute.tasks.geostatistics.kriging.KrigingDiagnosticsResult
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py)
::: evo.compute.tasks.geostatistics.kriging.KrigingTargetResult
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/geostatistics/kriging.py)
::: evo.compute.tasks.geostatistics.kriging.RECOMMENDED_DIAGNOSTIC_NAMES
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[GitHub source](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-compute/src/evo/compute/tasks/common/source_target.py)
::: evo.compute.tasks.common.source_target.attribute_spec
options:
show_labels: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
<!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">



<link rel="shortcut icon" href="../../../../img/favicon.ico">
<title>ReportCell - Evo Python SDK</title>
<link href="../../../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../../../css/fontawesome.min.css" rel="stylesheet">
<link href="../../../../css/brands.min.css" rel="stylesheet">
<link href="../../../../css/solid.min.css" rel="stylesheet">
<link href="../../../../css/v4-font-face.min.css" rel="stylesheet">
<link href="../../../../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<link href="../../../../assets/_mkdocstrings.css" rel="stylesheet">
</head>

<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="../../../..">Evo Python SDK</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>

<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">

<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a rel="prev" href="ReportCategorySpec.html" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="ReportCellStatus.html" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>


<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">

<li class="nav-item" data-bs-level="2"><a href="#evo.blockmodels.typed.report.ReportCell" class="nav-link">ReportCell</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">

<p><a href="https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-blockmodels/src/evo/blockmodels/typed/report.py">GitHub source</a>
</p>


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



<h2 id="evo.blockmodels.typed.report.ReportCell" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">evo.blockmodels.typed.report.ReportCell</span>


</h2>


<div class="doc doc-contents first">



<p>A single report/comparison cell: a numeric value plus a status.</p>
<p>The status explains why a value may be <code>null</code> (could not be aggregated/calculated).
See <code>ReportCellStatus</code> for the possible reasons.</p>











<div class="doc doc-children">







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



<h3 id="evo.blockmodels.typed.report.ReportCell.value" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">value</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">value</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="n">StrictInt</span> <span class="o">|</span> <span class="n">StrictFloat</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">Field</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="s1">&#39;Value&#39;</span><span class="p">,</span> <span class="n">examples</span><span class="o">=</span><span class="p">[</span><span class="mf">2.7</span><span class="p">])]</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Value of the cell. This is <code>null</code> whenever <code>status</code> is not <code>OK</code>.</p>

</div>

</div>

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



<h3 id="evo.blockmodels.typed.report.ReportCell.status" class="doc doc-heading">
<span class="doc doc-object-name doc-attribute-name">status</span>


</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="n">status</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="n">ReportCellStatus</span><span class="p">,</span> <span class="n">Field</span><span class="p">(</span><span class="n">examples</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;OK&#39;</span><span class="p">])]</span> <span class="o">=</span> <span class="n">OK</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Status of the cell, describing how <code>value</code> should be interpreted.</p>

</div>

</div>






</div>

</div>

</div></div>
</div>
</div>

<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>

</body>
</html>
Loading
Loading