[DOC]

gempy-project · Oct 11, 2023 · 3d8bfe0 · 3d8bfe0
commit 3d8bfe0
Show file tree

Hide file tree

Showing 320 changed files with 40,004 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: 9243702ad23780a6ac856473f2e98436
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/temp_gp3_docs.iml b/.idea/temp_gp3_docs.iml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/.nojekyll b/.nojekyll
diff --git a/GemPy API/gempy.compute_model.html b/GemPy API/gempy.compute_model.html
@@ -0,0 +1,209 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <title>gempy.compute_model &#8212; GemPy 2023.2.0b1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=270d38c7" />
+    <link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=61a4c737" />
+    <link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v=f4aeca0c" />
+    <link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v=e5fbc548" />
+    <link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=39c4bfd0"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <link rel="icon" href="../_static/favicon.ico"/>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="gempy.create_geomodel" href="gempy.create_geomodel.html" />
+    <link rel="prev" title="Code" href="../api_reference.html" />
+
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="gempy-compute-model">
+<h1>gempy.compute_model<a class="headerlink" href="#gempy-compute-model" title="Permalink to this heading">¶</a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="gempy.compute_model">
+<span class="sig-prename descclassname"><span class="pre">gempy.</span></span><span class="sig-name descname"><span class="pre">compute_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gempy_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../Modeling%20Classes/gempy.core.data.GeoModel.html#gempy.core.data.GeoModel" title="gempy.core.data.geo_model.GeoModel"><span class="pre">GeoModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GemPyEngineConfig</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="../Modeling%20Classes/gempy.core.data.Solutions.html#gempy.core.data.Solutions" title="gempy_engine.core.data.solutions.Solutions"><span class="pre">Solutions</span></a></span></span><a class="reference internal" href="../_modules/gempy/API/compute_API.html#compute_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gempy.compute_model" title="Permalink to this definition">¶</a></dt>
+<dd><p>Compute the geological model given the provided GemPy model.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>gempy_model</strong> (<a class="reference internal" href="../Modeling%20Classes/gempy.core.data.GeoModel.html#gempy.core.data.GeoModel" title="gempy.core.data.GeoModel"><em>GeoModel</em></a>) – The GemPy model to compute.</p></li>
+<li><p><strong>engine_config</strong> (<em>Optional</em><em>[</em><em>GemPyEngineConfig</em><em>]</em>) – Configuration for the computational engine. Defaults to None, in which case a default configuration will be used.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>ValueError</strong> – If the provided backend in the engine_config is not supported.</p>
+</dd>
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The computed geological model.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="../Modeling%20Classes/gempy.core.data.Solutions.html#gempy.core.data.Solutions" title="gempy.core.data.Solutions">Solutions</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+<section id="examples-using-gempy-compute-model">
+<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.compute_model</span></code><a class="headerlink" href="#examples-using-gempy-compute-model" title="Permalink to this heading">¶</a></h2>
+<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="Getting Started"><img alt="" src="../_images/sphx_glr_get_started_thumb.png" />
+<p><a class="reference internal" href="../tutorials/a_getting_started/get_started.html#sphx-glr-tutorials-a-getting-started-get-started-py"><span class="std std-ref">Getting Started</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Getting Started</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="1.1 -Basics of geological modeling with GemPy"><img alt="" src="../_images/sphx_glr_ch1_1_basics_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_1_basics.html#sphx-glr-tutorials-ch1-fundamentals-ch1-1-basics-py"><span class="std std-ref">1.1 -Basics of geological modeling with GemPy</span></a></p>
+  <div class="sphx-glr-thumbnail-title">1.1 -Basics of geological modeling with GemPy</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="1.3c: Adding topography to geological models"><img alt="" src="../_images/sphx_glr_ch1_3c_topography_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_3c_topography.html#sphx-glr-tutorials-ch1-fundamentals-ch1-3c-topography-py"><span class="std std-ref">1.3c: Adding topography to geological models</span></a></p>
+  <div class="sphx-glr-thumbnail-title">1.3c: Adding topography to geological models</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="1.4: Unconformity relationships"><img alt="" src="../_images/sphx_glr_ch1_4_onlap_relations_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_4_onlap_relations.html#sphx-glr-tutorials-ch1-fundamentals-ch1-4-onlap-relations-py"><span class="std std-ref">1.4: Unconformity relationships</span></a></p>
+  <div class="sphx-glr-thumbnail-title">1.4: Unconformity relationships</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="1.5: Fault relations"><img alt="" src="../_images/sphx_glr_ch1_5_fault_relations_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_5_fault_relations.html#sphx-glr-tutorials-ch1-fundamentals-ch1-5-fault-relations-py"><span class="std std-ref">1.5: Fault relations</span></a></p>
+  <div class="sphx-glr-thumbnail-title">1.5: Fault relations</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="1.6: 2D Visualization."><img alt="" src="../_images/sphx_glr_ch1_6_2d_visualization_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_6_2d_visualization.html#sphx-glr-tutorials-ch1-fundamentals-ch1-6-2d-visualization-py"><span class="std std-ref">1.6: 2D Visualization.</span></a></p>
+  <div class="sphx-glr-thumbnail-title">1.6: 2D Visualization.</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="3.1: Simple example of kriging in gempy"><img alt="" src="../_images/sphx_glr_ch3_1_kriging_interpolation_and_simulation_thumb.png" />
+<p><a class="reference internal" href="../tutorials/ch3-Interpolations/ch3_1_kriging_interpolation_and_simulation.html#sphx-glr-tutorials-ch3-interpolations-ch3-1-kriging-interpolation-and-simulation-py"><span class="std std-ref">3.1: Simple example of kriging in gempy</span></a></p>
+  <div class="sphx-glr-thumbnail-title">3.1: Simple example of kriging in gempy</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script demonstrates how to create a basic model of horizontally stacked layers using GemPy..."><img alt="" src="../_images/sphx_glr_a01_horizontal_stratigraphic_thumb.png" />
+<p><a class="reference internal" href="../examples/a01_horizontal_stratigraphic.html#sphx-glr-examples-a01-horizontal-stratigraphic-py"><span class="std std-ref">Model 1 - Horizontal stratigraphic</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 1 - Horizontal stratigraphic</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script demonstrates how to create a geological model of an anticline structure using GemPy..."><img alt="" src="../_images/sphx_glr_b02_fold_thumb.png" />
+<p><a class="reference internal" href="../examples/b02_fold.html#sphx-glr-examples-b02-fold-py"><span class="std std-ref">Model 2 - Anticline</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 2 - Anticline</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script demonstrates how to create a geological model of a recumbent fold using GemPy, a Py..."><img alt="" src="../_images/sphx_glr_c03_recumbent_fold_thumb.png" />
+<p><a class="reference internal" href="../examples/c03_recumbent_fold.html#sphx-glr-examples-c03-recumbent-fold-py"><span class="std std-ref">Model 3 - Recumbent Fold</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 3 - Recumbent Fold</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script demonstrates how to create a geological model with a layer of varying thickness (pi..."><img alt="" src="../_images/sphx_glr_d04_pinchout_thumb.png" />
+<p><a class="reference internal" href="../examples/d04_pinchout.html#sphx-glr-examples-d04-pinchout-py"><span class="std std-ref">Model 4 - Pinchout</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 4 - Pinchout</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script demonstrates how to create a simple fault model with constant offset using GemPy, a..."><img alt="" src="../_images/sphx_glr_e05_fault_thumb.png" />
+<p><a class="reference internal" href="../examples/e05_fault.html#sphx-glr-examples-e05-fault-py"><span class="std std-ref">Model 5 - Fault</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 5 - Fault</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script creates an unconformity cutting an anticline structure using GemPy, an open-source,..."><img alt="" src="../_images/sphx_glr_f06_unconformity_thumb.png" />
+<p><a class="reference internal" href="../examples/f06_unconformity.html#sphx-glr-examples-f06-unconformity-py"><span class="std std-ref">Model 6 - Unconformity</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 6 - Unconformity</div>
+</div><div class="sphx-glr-thumbcontainer" tooltip="This script creates a folded domain featuring an unconformity and a fault using GemPy, an open-..."><img alt="" src="../_images/sphx_glr_g07_combination_thumb.png" />
+<p><a class="reference internal" href="../examples/g07_combination.html#sphx-glr-examples-g07-combination-py"><span class="std std-ref">Model 7 - Combination</span></a></p>
+  <div class="sphx-glr-thumbnail-title">Model 7 - Combination</div>
+</div></div><div class="sphx-glr-clear"></div></section>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<p class="logo">
+  <a href="../index.html">
+    <img class="logo" src="../_static/logos/gempy.png" alt="Logo"/>
+
+  </a>
+</p>
+
+
+
+
+
+
+<p>
+<iframe src="https://ghbtns.com/github-btn.html?user=gempy-project&repo=gempy&type=star&count=true&size=large&v=2"
+  allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+
+
+
+
+
+<h3>Navigation</h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../index.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../projects.html">Additional projects</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">GemPy Tutorials</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples/index.html">Simple geometries</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api_reference.html">Code</a><ul class="current">
+<li class="toctree-l2 current"><a class="reference internal" href="../api_reference.html#gempy-api">GemPy API</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api_reference.html#plot">Plot</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../api_reference.html#data-classes">Data Classes</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  <li><a href="../api_reference.html">Code</a><ul>
+      <li>Previous: <a href="../api_reference.html" title="previous chapter">Code</a></li>
+      <li>Next: <a href="gempy.create_geomodel.html" title="next chapter">gempy.create_geomodel</a></li>
+  </ul></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2017-2023, Gempy Developers.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+      |
+      <a href="../_sources/GemPy API/gempy.compute_model.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>