-
Notifications
You must be signed in to change notification settings - Fork 0
/
installation.html
257 lines (227 loc) · 12.4 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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Installing GIANT — GIANT 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="icon" href="_static/logo.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="Getting Started" href="getting_started.html" />
<link rel="prev" title="Goddard Image Analysis and Navigation Tool" 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="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a>
</p>
<p class="blurb">A powerful API for Optical Navigation</p>
<p>
<iframe src="https://ghbtns.com/github-btn.html?user=nasa&repo=giant&type=watch&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 current"><a class="current reference internal" href="#">Installing GIANT</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="giant.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="giant.html#indices">Indices</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright</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">Goddard Image Analysis and Navigation Tool</a></li>
<li>Next: <a href="getting_started.html" title="next chapter">Getting Started</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="documentwrapper">
<div class="bodywrapper">
<div class="related top">
<nav id="rellinks">
<ul>
<li>
←
<a href="index.html" title="Previous document">Goddard Image Analysis and Navigation Tool</a>
</li>
<li>
<a href="getting_started.html" title="Next document">Getting Started</a>
→
</li>
</ul>
</nav>
</div>
<div class="body" role="main">
<section id="installing-giant">
<span id="installation"></span><h1>Installing GIANT<a class="headerlink" href="#installing-giant" title="Permalink to this heading">¶</a></h1>
<section id="setting-up-the-environment">
<h2>Setting up the environment<a class="headerlink" href="#setting-up-the-environment" title="Permalink to this heading">¶</a></h2>
<p>GIANT is primarily a python package with some modules written in Cython for speed improvements. This makes installation
fairly straight forward in most Unix-like environments. It should be possible to install GIANT on windows using similar
steps to those that follow, but this is untested. The following subsections give step by step instructions for
installing GIANT.</p>
<p>The first step to installing GIANT is to install the mamba-forge python environment/package manager. This helps to
ensure that the GIANT requirements don’t interfere with other python code you have on your system (and that other python
environments you have don’t interfere with GIANT). Mamba-forge can be downloaded fom
<a class="reference external" href="https://github.com/conda-forge/miniforge#mambaforge">https://github.com/conda-forge/miniforge#mambaforge</a>
Once you have downloaded anaconda, install it following the instructions provided (note that you can install it to your
home directory without needing admin privileges, which is a big benefit).</p>
<p>With mamba installed, we can now set up an environment in which to install giant</p>
<ol class="arabic simple">
<li><dl class="simple">
<dt>Before we begin there are a couple OS specific instructions</dt><dd><ul class="simple">
<li><dl class="simple">
<dt>macOS</dt><dd><ul>
<li><p>You may need to set the environment variable <code class="docutils literal notranslate"><span class="pre">CPATH</span></code> to something like
<code class="docutils literal notranslate"><span class="pre">/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include</span></code>
or <code class="docutils literal notranslate"><span class="pre">/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include</span></code> after installing xcode or xcode command
line tools to ensure system headers are available</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Windows</dt><dd><ul>
<li><dl class="simple">
<dt>You will need to install the Visual Studio 2017 developer tools according to the instructions at <a class="reference external" href="https://conda-forge.org/docs/maintainer/knowledge_base.html#local-testing">https://conda-forge.org/docs/maintainer/knowledge_base.html#local-testing</a></dt><dd><ul>
<li><p>Note that you must do this before activating the environment as described below</p></li>
<li><p>At this time it looks like Visual Studio 2017 is required (more recent will not work)</p></li>
</ul>
</dd>
</dl>
</li>
<li><p>You will need to manually install imagemagick from <a class="reference external" href="https://imagemagick.org/script/download.php">https://imagemagick.org/script/download.php</a></p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Create a new environment to install GIANT to and install the dependencies</dt><dd><ul class="simple">
<li><dl class="simple">
<dt><code class="code docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">create</span> <span class="pre">-n</span> <span class="pre">giant_env</span> <span class="pre">python=3</span> <span class="pre">opencv</span> <span class="pre">matplotlib</span> <span class="pre">scipy</span> <span class="pre">pandas</span> <span class="pre">numpy</span> <span class="pre">cython</span> <span class="pre">pyqt</span> <span class="pre">astropy</span> <span class="pre">lxml</span> <span class="pre">sphinx</span> <span class="pre">spiceypy</span> <span class="pre">c-compiler</span> <span class="pre">llvm-openmp</span> <span class="pre">astroquery</span> <span class="pre">dill</span> <span class="pre">psutil</span></code></dt><dd><ul>
<li><p>If you are on Mac or Linux you can install imagemagick with the same command by including <code class="docutils literal notranslate"><span class="pre">imagemagick</span></code> at the end of the above command.</p></li>
</ul>
</dd>
</dl>
</li>
<li><p>Note that creating a new environment is not required, but is strongly recommended.</p></li>
<li><p>Note that if you did not install mamba-forge, you need to specify to use the conda-forge repository instead of the default conda repository by adding <code class="code docutils literal notranslate"><span class="pre">-c</span> <span class="pre">conda-forge</span></code> to the <code class="code docutils literal notranslate"><span class="pre">mamba</span> <span class="pre">create</span></code> command.</p></li>
<li><p>Note that if you are on windows, you will unfortunately need to manually install vs2017 according to the instructions <a class="reference external" href="https://conda-forge.org/docs/maintainer/knowledge_base.html#local-testing">https://conda-forge.org/docs/maintainer/knowledge_base.html#local-testing</a></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Activate the new environment</dt><dd><ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">conda</span> <span class="pre">activate</span> <span class="pre">giant_env</span></code></p></li>
<li><p>If you did not create a new environment then this step is not necessary (as long as the mamba python is first
in your path).</p></li>
<li><p>You will need to do this step each time you want to use GIANT.</p></li>
</ul>
</dd>
</dl>
</li>
</ol>
</section>
<section id="installing-and-testing-giant">
<h2>Installing and testing GIANT<a class="headerlink" href="#installing-and-testing-giant" title="Permalink to this heading">¶</a></h2>
<p>With the anaconda environment set up and activated it is now easy to install giant.</p>
<ol class="arabic simple">
<li><dl class="simple">
<dt>Download the GIANT source code from git</dt><dd><ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git@github.com:nasa/giant.git</span></code></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Install the GIANT package</dt><dd><ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">cd</span> <span class="pre">giant</span></code></p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.</span></code></p></li>
<li><p>You can also omit the “-e” to avoid using links, but using links makes it easier to update GIANT in the future.</p></li>
<li><p>You will likely see a lot of warnings from the c compiler that can largely be ignored. If you have an error
though that is a problem</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Check the installation (optional)</dt><dd><ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">cd</span> <span class="pre">unittests</span></code></p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">python</span> <span class="pre">-Wignore</span> <span class="pre">-m</span> <span class="pre">unittest</span> <span class="pre">discover</span></code></p></li>
<li><p>This should complete with no errors (skips/warnings are OK).</p></li>
</ul>
</dd>
</dl>
</li>
</ol>
<p>GIANT should now be installed and ready for use.</p>
</section>
</section>
</div>
<div class="related bottom">
<nav id="rellinks">
<ul>
<li>
←
<a href="index.html" title="Previous document">Goddard Image Analysis and Navigation Tool</a>
</li>
<li>
<a href="getting_started.html" title="Next document">Getting Started</a>
→
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2023 United States Government |
NASA Official: <a href="mailto:[email protected]">Andrew Liounis</a> |
Curator: <a href="mailto:[email protected]">Andrew Liounis</a>
<br>
Last updated on Mar 08, 2023 |
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 6.1.3</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>