Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update #966

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Documentation update #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c54bc2a
Updated documentation
flohorovicic Dec 14, 2024
64e960e
Updated documentation and cleaned .gitignore
flohorovicic Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 16 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
docs/source/gen_modules/backreferences/
gempy/core/__pycache__/
gempy/API/__pycache__/
gempy/core/data/__pycache__/
gempy/core/data/grid_modules/__pycache__/
gempy/modules/data_manipulation/__pycache__/
gempy/modules/__pycache__/
gempy/__pycache__/
gempy/API/gp2_gp3_compatibility/__pycache__/
gempy/modules/custom_implicit_functions/__pycache__/__init__.cpython-310.pyc
gempy/modules/custom_implicit_functions/__pycache__/ellipsoid_implicit_function.cpython-310.pyc
gempy/modules/grids/__pycache__/__init__.cpython-310.pyc
gempy/modules/grids/__pycache__/create_topography.cpython-310.pyc
.ENV
.DS_Store
git_status.txt
49 changes: 22 additions & 27 deletions GemPy API/gempy.add_orientations.html
View file
Open in desktop

Large diffs are not rendered by default.

43 changes: 19 additions & 24 deletions GemPy API/gempy.add_structural_group.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@
<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.add_structural_group &#8212; GemPy 2024.2.0.3.dev0+gf344a731.d20240626 documentation</title>
<title>gempy.add_structural_group &#8212; GemPy 2024.2.0.2 documentation</title>
<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/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=e15417cb" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<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=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<script src="../_static/documentation_options.js?v=bd57e1ea"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<script src="../_static/documentation_options.js?v=6d9f68de"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></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 @@ -26,8 +27,9 @@

<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>

Expand All @@ -53,11 +55,11 @@ <h1>gempy.add_structural_group<a class="headerlink" href="#gempy-add-structural-

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../index.html">
<img class="logo" src="../_static/logos/gempy.png" alt="Logo"/>
<img class="logo" src="../_static/logos/gempy.png" alt="Logo" />

</a>
</p>
Expand All @@ -81,22 +83,15 @@ <h3>Navigation</h3>
<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>
</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">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">External examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../external/external_examples.html">External Examples</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 current"><a class="reference internal" href="../api_reference.html">Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_reference.html#data-classes">Data Classes</a></li>
</ul>

Expand All @@ -111,15 +106,15 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>


Expand All @@ -134,11 +129,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2024, Gempy Developers.
&#169;2017-2024, Gempy Developers.

|
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>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>

|
<a href="../_sources/GemPy API/gempy.add_structural_group.rst.txt"
Expand Down
49 changes: 22 additions & 27 deletions GemPy API/gempy.add_surface_points.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@
<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.add_surface_points &#8212; GemPy 2024.2.0.3.dev0+gf344a731.d20240626 documentation</title>
<title>gempy.add_surface_points &#8212; GemPy 2024.2.0.2 documentation</title>
<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/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=e15417cb" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<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=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<script src="../_static/documentation_options.js?v=bd57e1ea"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<script src="../_static/documentation_options.js?v=6d9f68de"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></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 @@ -26,8 +27,9 @@

<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>

Expand Down Expand Up @@ -74,9 +76,9 @@ <h1>gempy.add_surface_points<a class="headerlink" href="#gempy-add-surface-point

<section id="examples-using-gempy-add-surface-points">
<h2>Examples using <code class="docutils literal notranslate"><span class="pre">gempy.add_surface_points</span></code><a class="headerlink" href="#examples-using-gempy-add-surface-points" title="Link 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 class="sphx-glr-thumbnails"><div class="sphx-glr-thumbcontainer" tooltip="Video Tutorial &quot;code-along&quot;: Modeling step by step"><img alt="" src="../_images/sphx_glr_video_tutorial_model_1_thumb.png" />
<p><a class="reference internal" href="../tutorials/z_other_tutorials/video_tutorial_model_1.html#sphx-glr-tutorials-z-other-tutorials-video-tutorial-model-1-py"><span class="std std-ref">Video Tutorial “code-along”: Modeling step by step</span></a></p>
<div class="sphx-glr-thumbnail-title">Video Tutorial "code-along": Modeling step by step</div>
</div></div><div class="sphx-glr-clear"></div></section>
</section>

Expand All @@ -85,11 +87,11 @@ <h2>Examples using <code class="docutils literal notranslate"><span class="pre">

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../index.html">
<img class="logo" src="../_static/logos/gempy.png" alt="Logo"/>
<img class="logo" src="../_static/logos/gempy.png" alt="Logo" />

</a>
</p>
Expand All @@ -113,22 +115,15 @@ <h3>Navigation</h3>
<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>
</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">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">External examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../external/external_examples.html">External Examples</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 current"><a class="reference internal" href="../api_reference.html">Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_reference.html#data-classes">Data Classes</a></li>
</ul>

Expand All @@ -143,15 +138,15 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>


Expand All @@ -166,11 +161,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2024, Gempy Developers.
&#169;2017-2024, Gempy Developers.

|
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>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>

|
<a href="../_sources/GemPy API/gempy.add_surface_points.rst.txt"
Expand Down
43 changes: 19 additions & 24 deletions GemPy API/gempy.calculate_gravity_gradient.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@
<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.calculate_gravity_gradient &#8212; GemPy 2024.2.0.3.dev0+gf344a731.d20240626 documentation</title>
<title>gempy.calculate_gravity_gradient &#8212; GemPy 2024.2.0.2 documentation</title>
<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/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=686e5160" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=e15417cb" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=d2d258e8" />
<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=2082cf3c" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<script src="../_static/documentation_options.js?v=bd57e1ea"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<script src="../_static/documentation_options.js?v=6d9f68de"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></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 @@ -26,8 +27,9 @@

<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>

Expand All @@ -53,11 +55,11 @@ <h1>gempy.calculate_gravity_gradient<a class="headerlink" href="#gempy-calculate

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="../index.html">
<img class="logo" src="../_static/logos/gempy.png" alt="Logo"/>
<img class="logo" src="../_static/logos/gempy.png" alt="Logo" />

</a>
</p>
Expand All @@ -81,22 +83,15 @@ <h3>Navigation</h3>
<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>
</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">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">External examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../external/external_examples.html">External Examples</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 current"><a class="reference internal" href="../api_reference.html">Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api_reference.html#data-classes">Data Classes</a></li>
</ul>

Expand All @@ -111,15 +106,15 @@ <h3>Related Topics</h3>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<search 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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>


Expand All @@ -134,11 +129,11 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017-2024, Gempy Developers.
&#169;2017-2024, Gempy Developers.

|
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>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>

|
<a href="../_sources/GemPy API/gempy.calculate_gravity_gradient.rst.txt"
Expand Down
Loading