-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathinstall_windows.html
More file actions
223 lines (210 loc) · 12.7 KB
/
install_windows.html
File metadata and controls
223 lines (210 loc) · 12.7 KB
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
<!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="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>Windows Installation — SpacePy v0.7.0 Manual</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css?v=92e3d466" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<script src="_static/documentation_options.js?v=fe7df9b0"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script type="text/javascript" src="_static/copybutton.js"></script>
<link rel="icon" href="_static/spacepy_favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="SpacePy - A Quick Start Documentation" href="quickstart.html" />
<link rel="prev" title="MacOS Installation" href="install_mac.html" />
</head><body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="index.html"><img src="_static/spacepy_logo.jpg" border="0" alt="spacepy_logo"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="quickstart.html" title="SpacePy - A Quick Start Documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="install_mac.html" title="MacOS Installation"
accesskey="P">previous</a> |</li>
<li><a href="https://spacepy.github.io/"">homepage</a>| </li>
<li><a href="https://github.com/spacepy/spacepy">development</a>| </li>
<li><a href="search.html">search</a>| </li>
<li><a href="index.html">documentation </a> »</li>
<li class="nav-item nav-item-1"><a href="install.html" accesskey="U">Installing SpacePy</a> »</li>
<li class="nav-item nav-item-this"><a href="">Windows Installation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="windows-installation">
<h1>Windows Installation<a class="headerlink" href="#windows-installation" title="Link to this heading">¶</a></h1>
<p>The SpacePy team currently provides binary “wheels” via PyPI so it can
be installed on Windows without a compiler. Binaries are provided for
64-bit x86. <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">spacepy</span></code> should find and install these
binaries. These include the necessary Fortran runtime and the NASA CDF
library.</p>
<p>Our recommended (but not required) Python distribution is <a class="reference external" href="https://docs.anaconda.com/anaconda/">Anaconda</a> running 64-bit
Python 3. Anaconda includes much of the scientific Python
stack.</p>
<p>If you prefer to install the dependencies some way other than pip, see
<a class="reference internal" href="#win-dep-conda"><span class="std std-ref">Dependencies via conda</span></a>.</p>
<p>Wheels are built inside a VM running Windows 10 22H2 and should run on
Windows 10 and 11.</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#compiling" id="id1">Compiling</a></p></li>
<li><p><a class="reference internal" href="#nasa-cdf" id="id2">NASA CDF</a></p></li>
<li><p><a class="reference internal" href="#dependencies-via-conda" id="id3">Dependencies via conda</a></p></li>
<li><p><a class="reference internal" href="#standalone-dependencies" id="id4">Standalone dependencies</a></p></li>
<li><p><a class="reference internal" href="#developers" id="id5">Developers</a></p></li>
</ul>
</nav>
<section id="compiling">
<span id="windows-compiling"></span><h2><a class="toc-backref" href="#id1" role="doc-backlink">Compiling</a><a class="headerlink" href="#compiling" title="Link to this heading">¶</a></h2>
<p>If a binary wheel is not available for your version of Python, <code class="docutils literal notranslate"><span class="pre">pip</span></code>
will try to compile SpacePy. The only supported compiler is
<code class="docutils literal notranslate"><span class="pre">mingw32</span></code>. Install it with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">m2w64</span><span class="o">-</span><span class="n">gcc</span><span class="o">-</span><span class="n">fortran</span> <span class="n">libpython</span>
</pre></div>
</div>
<p>This is also required if installing from a source distribution or git checkout.</p>
<p><a class="reference internal" href="autosummary/spacepy.irbempy.html#module-spacepy.irbempy" title="spacepy.irbempy"><code class="xref py py-mod docutils literal notranslate"><span class="pre">irbempy</span></code></a> requires Fortran to compile and the only
supported compiler is <code class="docutils literal notranslate"><span class="pre">gnu95</span></code>; this is the default and provided
by <code class="docutils literal notranslate"><span class="pre">m2w64-gcc-fortran</span></code>.</p>
<p>If you have difficulties, it may be useful to reference the <a class="reference external" href="https://github.com/spacepy/spacepy/tree/main/developer/scripts">build
scripts</a>
the SpacePy developers use.</p>
</section>
<section id="nasa-cdf">
<span id="windows-cdf"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">NASA CDF</a><a class="headerlink" href="#nasa-cdf" title="Link to this heading">¶</a></h2>
<p>SpacePy binary wheels ship with a copy of the NASA CDF library and
<a class="reference internal" href="autosummary/spacepy.pycdf.html#module-spacepy.pycdf" title="spacepy.pycdf"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pycdf</span></code></a> will use this copy if no other CDF libraries can
be found.</p>
<p>If you build SpacePy from source or wish to use a different version of
the library, you can download it from the <a class="reference external" href="https://cdf.gsfc.nasa.gov/html/sw_and_docs.html">NASA CDF page</a>. Binary
installers are available for Windows; be sure to pick the version
(32-bit or 64-bit) that matches your Python installation.</p>
<p>NASA CDF can be installed either before or after installing SpacePy.</p>
</section>
<section id="dependencies-via-conda">
<span id="win-dep-conda"></span><h2><a class="toc-backref" href="#id3" role="doc-backlink">Dependencies via conda</a><a class="headerlink" href="#dependencies-via-conda" title="Link to this heading">¶</a></h2>
<p>Installation via <code class="docutils literal notranslate"><span class="pre">pip</span></code> will automatically install most Python
dependencies (but not the <a class="reference internal" href="#windows-cdf"><span class="std std-ref">NASA CDF library</span></a>).
They can also be installed from conda:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">numpy</span> <span class="n">python</span><span class="o">-</span><span class="n">dateutil</span> <span class="n">scipy</span> <span class="n">matplotlib</span> <span class="n">h5py</span>
</pre></div>
</div>
</section>
<section id="standalone-dependencies">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Standalone dependencies</a><a class="headerlink" href="#standalone-dependencies" title="Link to this heading">¶</a></h2>
<p>Most of the <a class="reference internal" href="dependencies.html"><span class="doc">SpacePy Dependencies</span></a> have Windows installers available via
their pages, but <code class="docutils literal notranslate"><span class="pre">pip</span></code> or <code class="docutils literal notranslate"><span class="pre">conda</span></code> are recommended instead.</p>
</section>
<section id="developers">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Developers</a><a class="headerlink" href="#developers" title="Link to this heading">¶</a></h2>
<p>If you want to build the documentation yourself (rather than using the
documentation shipped with SpacePy), install sphinx and numpydoc. The
easiest way is via pip:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">sphinx</span> <span class="n">numpydoc</span>
</pre></div>
</div>
<p>They are also available via conda:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">sphinx</span> <span class="n">numpydoc</span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</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/logo.png" alt="Logo"/>
</a></p>
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Windows Installation</a><ul>
<li><a class="reference internal" href="#compiling">Compiling</a></li>
<li><a class="reference internal" href="#nasa-cdf">NASA CDF</a></li>
<li><a class="reference internal" href="#dependencies-via-conda">Dependencies via conda</a></li>
<li><a class="reference internal" href="#standalone-dependencies">Standalone dependencies</a></li>
<li><a class="reference internal" href="#developers">Developers</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="install_mac.html"
title="previous chapter">MacOS Installation</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="quickstart.html"
title="next chapter">SpacePy - A Quick Start Documentation</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/install_windows.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<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>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="quickstart.html" title="SpacePy - A Quick Start Documentation"
>next</a> |</li>
<li class="right" >
<a href="install_mac.html" title="MacOS Installation"
>previous</a> |</li>
<li><a href="https://spacepy.github.io/"">homepage</a>| </li>
<li><a href="https://github.com/spacepy/spacepy">development</a>| </li>
<li><a href="search.html">search</a>| </li>
<li><a href="index.html">documentation </a> »</li>
<li class="nav-item nav-item-1"><a href="install.html" >Installing SpacePy</a> »</li>
<li class="nav-item nav-item-this"><a href="">Windows Installation</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2024, The SpacePy Team.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>