Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Leguark committed May 13, 2024
1 parent 5d954b8 commit 74cc70a
Show file tree
Hide file tree
Showing 215 changed files with 994 additions and 985 deletions.
9 changes: 6 additions & 3 deletions GemPy API/gempy.compute_model.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,12 @@ <h1>gempy.compute_model<a class="headerlink" href="#gempy-compute-model" title="

<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="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="1.7: 3-D Visualization"><img alt="" src="../_images/sphx_glr_ch1_7_3d_visualization_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_7_3d_visualization.html#sphx-glr-tutorials-ch1-fundamentals-ch1-7-3d-visualization-py"><span class="std std-ref">1.7: 3-D Visualization</span></a></p>
<div class="sphx-glr-thumbnail-title">1.7: 3-D Visualization</div>
<div class="sphx-glr-thumbnails"><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="# %% # .. 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><div class="sphx-glr-clear"></div></section>
</section>

Expand Down
9 changes: 6 additions & 3 deletions GemPy API/gempy.create_geomodel.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,12 @@ <h1>gempy.create_geomodel<a class="headerlink" href="#gempy-create-geomodel" tit

<section id="examples-using-gempy-create-geomodel">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.create_geomodel</span></code><a class="headerlink" href="#examples-using-gempy-create-geomodel" title="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="2.1 Forward Gravity: Simple example"><img alt="" src="../_images/sphx_glr_ch2_1_gravity_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch2-Geophysics/ch2_1_gravity.html#sphx-glr-tutorials-ch2-geophysics-ch2-1-gravity-py"><span class="std std-ref">2.1 Forward Gravity: Simple example</span></a></p>
<div class="sphx-glr-thumbnail-title">2.1 Forward Gravity: Simple example</div>
<div class="sphx-glr-thumbnails"><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="# %% # .. 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><div class="sphx-glr-clear"></div></section>
</section>

Expand Down
6 changes: 3 additions & 3 deletions GemPy API/gempy.map_stack_to_surfaces.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ <h1>gempy.map_stack_to_surfaces<a class="headerlink" href="#gempy-map-stack-to-s

<section id="examples-using-gempy-map-stack-to-surfaces">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.map_stack_to_surfaces</span></code><a class="headerlink" href="#examples-using-gempy-map-stack-to-surfaces" title="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="2.1 Forward Gravity: Simple example"><img alt="" src="../_images/sphx_glr_ch2_1_gravity_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch2-Geophysics/ch2_1_gravity.html#sphx-glr-tutorials-ch2-geophysics-ch2-1-gravity-py"><span class="std std-ref">2.1 Forward Gravity: Simple example</span></a></p>
<div class="sphx-glr-thumbnail-title">2.1 Forward Gravity: Simple example</div>
<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><div class="sphx-glr-clear"></div></section>
</section>

Expand Down
9 changes: 6 additions & 3 deletions Helper Classes/gempy.core.data.ImporterHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,12 @@ <h1>gempy.core.data.ImporterHelper<a class="headerlink" href="#gempy-core-data-i
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gempy.core.data.</span></span><span class="sig-name descname"><span class="pre">ImporterHelper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_to_surface_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_to_orientations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hash_surface_points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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>, <em class="sig-param"><span class="n"><span class="pre">hash_orientations</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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>, <em class="sig-param"><span class="n"><span class="pre">coord_x_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'X'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coord_y_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'Y'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coord_z_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'Z'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">surface_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'formation'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gx_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'G_x'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gy_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'G_y'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gz_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">'G_z'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pandas_reader_kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</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><a class="reference internal" href="../_modules/gempy/core/data/importer_helper.html#ImporterHelper"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gempy.core.data.ImporterHelper" title="Link to this definition"></a></dt>
<dd><section id="examples-using-gempy-core-data-importerhelper">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.core.data.ImporterHelper</span></code><a class="headerlink" href="#examples-using-gempy-core-data-importerhelper" title="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="2.1 Forward Gravity: Simple example"><img alt="" src="../_images/sphx_glr_ch2_1_gravity_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch2-Geophysics/ch2_1_gravity.html#sphx-glr-tutorials-ch2-geophysics-ch2-1-gravity-py"><span class="std std-ref">2.1 Forward Gravity: Simple example</span></a></p>
<div class="sphx-glr-thumbnail-title">2.1 Forward Gravity: Simple example</div>
<div class="sphx-glr-thumbnails"><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="# %% # .. 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><div class="sphx-glr-clear"></div><p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<tbody>
Expand Down
9 changes: 6 additions & 3 deletions Modeling Classes/gempy.core.data.GeoModel.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,12 @@ <h1>gempy.core.data.GeoModel<a class="headerlink" href="#gempy-core-data-geomode
<dd><p>Class representing a geological model.</p>
<section id="examples-using-gempy-core-data-geomodel">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.core.data.GeoModel</span></code><a class="headerlink" href="#examples-using-gempy-core-data-geomodel" title="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="1.7: 3-D Visualization"><img alt="" src="../_images/sphx_glr_ch1_7_3d_visualization_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch1_fundamentals/ch1_7_3d_visualization.html#sphx-glr-tutorials-ch1-fundamentals-ch1-7-3d-visualization-py"><span class="std std-ref">1.7: 3-D Visualization</span></a></p>
<div class="sphx-glr-thumbnail-title">1.7: 3-D Visualization</div>
<div class="sphx-glr-thumbnails"><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="# %% # .. 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><div class="sphx-glr-clear"></div><p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<tbody>
Expand Down
9 changes: 6 additions & 3 deletions Modeling Classes/gempy.core.data.Grid.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,12 @@ <h1>gempy.core.data.Grid<a class="headerlink" href="#gempy-core-data-grid" title

<section id="examples-using-gempy-core-data-grid">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.core.data.Grid</span></code><a class="headerlink" href="#examples-using-gempy-core-data-grid" title="Link to this heading"></a></h2>
<div class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="2.1 Forward Gravity: Simple example"><img alt="" src="../_images/sphx_glr_ch2_1_gravity_thumb.png" />
<p><a class="reference internal" href="../tutorials/ch2-Geophysics/ch2_1_gravity.html#sphx-glr-tutorials-ch2-geophysics-ch2-1-gravity-py"><span class="std std-ref">2.1 Forward Gravity: Simple example</span></a></p>
<div class="sphx-glr-thumbnail-title">2.1 Forward Gravity: Simple example</div>
<div class="sphx-glr-thumbnails"><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="# %% # .. 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><div class="sphx-glr-clear"></div><p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<tbody>
Expand Down
Loading

0 comments on commit 74cc70a

Please sign in to comment.