-
Notifications
You must be signed in to change notification settings - Fork 0
/
installation.html
201 lines (160 loc) · 9.43 KB
/
installation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html>
<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>Installation — GemPy 2023.2.0b1 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/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=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<script src="_static/documentation_options.js?v=acace1bb"></script>
<script src="_static/doctools.js?v=888ff710"></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" />
<link rel="next" title="Additional projects" href="projects.html" />
<link rel="prev" title="About" href="index.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="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
<section id="installing-gempy">
<h2>Installing <code class="docutils literal notranslate"><span class="pre">GemPy</span></code><a class="headerlink" href="#installing-gempy" title="Link to this heading">¶</a></h2>
<p>The latest release version of <code class="docutils literal notranslate"><span class="pre">GemPy</span></code> is available via <strong>PyPi</strong>. To install the core version, simply use pip:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gempy
</pre></div>
</div>
<p>This will install <code class="docutils literal notranslate"><span class="pre">GemPy</span></code> with the minimal required dependencies.</p>
</section>
<section id="enhanced-installation-options">
<h2>Enhanced Installation Options<a class="headerlink" href="#enhanced-installation-options" title="Link to this heading">¶</a></h2>
<p>For additional features, <code class="docutils literal notranslate"><span class="pre">GemPy</span></code> offers enhanced installation options:</p>
<ul>
<li><p>Base Features: For the majority of functionalities, install with base dependencies:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gempy<span class="o">[</span>base<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Optional Features: To access optional features such as data download support, install with optional dependencies:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gempy<span class="o">[</span>opt<span class="o">]</span>
</pre></div>
</div>
</li>
<li><p>Development Version: For development purposes, including testing tools:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gempy<span class="o">[</span>dev<span class="o">]</span>
</pre></div>
</div>
</li>
</ul>
<p>Note: Some functionalities in <code class="docutils literal notranslate"><span class="pre">GemPy</span></code> require <cite>PyTorch</cite> and <cite>pyvista</cite>. These libraries need to be installed separately:</p>
<ul class="simple">
<li><p>PyTorch: Follow the instructions on the <a class="reference external" href="https://pytorch.org/get-started/locally/">PyTorch installation page</a>.</p></li>
<li><p>PyVista: Installation guide available on the <a class="reference external" href="https://docs.pyvista.org/getting-started/installation.html">PyVista installation page</a>.</p></li>
</ul>
</section>
<section id="manual-installation">
<h2>Manual Installation<a class="headerlink" href="#manual-installation" title="Link to this heading">¶</a></h2>
<p>For the latest, cutting-edge version of <code class="docutils literal notranslate"><span class="pre">GemPy</span></code>, you can clone the repository and install it manually:</p>
<ol class="arabic">
<li><p>Clone the repository:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/cgre-aachen/gempy.git
</pre></div>
</div>
</li>
<li><p>Navigate to the root of the cloned repository and install using pip:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</pre></div>
</div>
</li>
</ol>
</section>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">GemPy</span></code> relies on numerous open-source libraries. Core dependencies are automatically installed with the package. Enhanced functionalities require additional dependencies, structured as follows:</p>
<ul class="simple">
<li><p>Core Dependencies: Installed with the basic package.</p></li>
<li><p>Base Dependencies: Additional libraries for extended functionalities (<cite>base-requirements.txt</cite>).</p></li>
<li><p>Optional Dependencies: Libraries for optional features (<cite>optional-requirements.txt</cite>).</p></li>
<li><p>Development Dependencies: Tools needed for development (<cite>dev-requirements.txt</cite>).</p></li>
</ul>
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">About</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installing-gempy">Installing <code class="docutils literal notranslate"><span class="pre">GemPy</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#enhanced-installation-options">Enhanced Installation Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="#manual-installation">Manual Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dependencies">Dependencies</a></li>
</ul>
</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">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><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>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">About</a></li>
<li>Next: <a href="projects.html" title="next chapter">Additional projects</a></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">
©2017-2023, Gempy Developers.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/installation.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>