Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Leguark committed Nov 22, 2023
1 parent da31ff2 commit 17f100d
Show file tree
Hide file tree
Showing 309 changed files with 3,393 additions and 3,278 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -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: 660a6cb4b9e46986b4bc4a9f1c9bf89d
config: 9fc8e8ecf729cf5a9b09a66b3a051028
tags: 645f666f9bcd5a90fca523b33c5a78b7
24 changes: 12 additions & 12 deletions GemPy API/gempy.compute_model.html
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="../">
<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/pygments.css?v=fa44fd50" />
<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-dataframe.css?v=2082cf3c" />
<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/documentation_options.js?v=acace1bb"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -37,10 +37,10 @@
<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>
<h1>gempy.compute_model<a class="headerlink" href="#gempy-compute-model" title="Link 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>
<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="Link 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>
Expand All @@ -62,13 +62,13 @@ <h1>gempy.compute_model<a class="headerlink" href="#gempy-compute-model" title="
</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>
<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="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="# %% # .. admonition:: Explanation # # This model is quite unstable in general and requir..."><img alt="" src="../_images/sphx_glr_Alesmodel_thumb.png" />
<p><a class="reference internal" href="../examples/real/Alesmodel.html#sphx-glr-examples-real-alesmodel-py"><span class="std std-ref">Alesmodel: Plotting sections and maps.</span></a></p>
<div class="sphx-glr-thumbnail-title">Alesmodel: Plotting sections and maps.</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="Greenstone."><img alt="" src="../_images/sphx_glr_Greenstone_thumb.png" />
<p><a class="reference internal" href="../examples/real/Greenstone.html#sphx-glr-examples-real-greenstone-py"><span class="std std-ref">Greenstone.</span></a></p>
<div class="sphx-glr-thumbnail-title">Greenstone.</div>
</div><div class="sphx-glr-thumbcontainer" tooltip="Perth basin."><img alt="" src="../_images/sphx_glr_Perth_basin_thumb.png" />
<p><a class="reference internal" href="../examples/real/Perth_basin.html#sphx-glr-examples-real-perth-basin-py"><span class="std std-ref">Perth basin.</span></a></p>
<div class="sphx-glr-thumbnail-title">Perth basin.</div>
</div></div><div class="sphx-glr-clear"></div></section>
</section>

Expand Down Expand Up @@ -158,7 +158,7 @@ <h3 id="searchlabel">Quick search</h3>
&copy;2017-2023, Gempy Developers.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.1.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>

|
Expand Down
Loading

0 comments on commit 17f100d

Please sign in to comment.