-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
329 lines (316 loc) · 19.2 KB
/
index.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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!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>SpacePy 0.7.0 documentation — 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="Installing SpacePy" href="install.html" />
</head><body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="#"><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="install.html" title="Installing SpacePy"
accesskey="N">next</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="#">documentation </a> »</li>
<li class="nav-item nav-item-this"><a href="">SpacePy 0.7.0 documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="spacepy-version-documentation">
<h1>SpacePy 0.7.0 documentation<a class="headerlink" href="#spacepy-version-documentation" title="Link to this heading">¶</a></h1>
<p>SpacePy is a package for Python, targeted at the space sciences, that aims to
make basic data analysis, modeling and visualization easier. It builds on the
capabilities of the well-known NumPy and MatPlotLib packages. Publication
quality output direct from analyses is emphasized among other goals:</p>
<blockquote>
<div><ul class="simple">
<li><p>Quickly obtain data</p></li>
<li><p>Create publications quality plots</p></li>
<li><p>Perform complicated analysis easily</p></li>
<li><p>Run common empirical models</p></li>
<li><p>Change coordinates effortlessly</p></li>
<li><p>Harness the power of Python</p></li>
</ul>
</div></blockquote>
<p>The SpacePy project seeks to promote accurate and open research standards by
providing an open environment for code development. In the space physics
community there has long been a significant reliance on proprietary languages
that restrict free transfer of data and reproducibility of results. By
providing a comprehensive, open-source library of widely-used analysis and
visualization tools in a free, modern and intuitive language, we hope that
this reliance will be diminished.</p>
<p>When publishing research which used SpacePy, please provide appropriate
credit to the SpacePy team via citation or acknowledgment.</p>
<dl class="simple">
<dt>To cite SpacePy in publications, use (BibTeX code):</dt><dd><p>@article{niehof2022spacepy,
title={The SpacePy space science package at 12 years},
author={Niehof, Jonathan T and Morley, Steven K and Welling, Daniel T and Larsen, Brian A},
journal={Frontiers in Astronomy and Space Sciences},
volume={9},
year={2022},
doi={10.3389/fspas.2022.1023612},
publisher={Frontiers}
}</p>
</dd>
<dt>To cite the code itself:</dt><dd><p>@software{spacepy_code,
author = {Morley, Steven K. and Niehof, Jonathan T. and
Welling, Daniel T. and Larsen, Brian A. and
Brunet, Antoine and Engel, Miles A. and
Gieseler, Jan and Haiducek, John and
Henderson, Michael and Hendry, Aaron and
Hirsch, Michael and Killick, Peter and
Koller, Josef and Merrill, Asher and
Rastatter, Lutz and Reimer, Ashton and
Shih, Albert Y. and Stricklan, Amanda},
title = {SpacePy},
publisher = {Zenodo},
doi = {10.5281/zenodo.3252523},
url = {<a class="reference external" href="https://doi.org/10.5281/zenodo.3252523">https://doi.org/10.5281/zenodo.3252523</a>}
}</p>
</dd>
</dl>
<p>Certain modules may provide additional citations in the <code class="docutils literal notranslate"><span class="pre">__citation__</span></code>
attribute. Contact a module’s author (details in the <code class="docutils literal notranslate"><span class="pre">__citation__</span></code> attribute)
before publication or public presentation of analysis performed by that
module, or in case of questions about the module. This allows the author to
validate the analysis and receive appropriate credit for his or her
work.</p>
</section>
<section id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading">¶</a></h1>
<p>First steps in SpacePy and scientific Python.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing SpacePy</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">SpacePy - A Quick Start Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="help.html">SpacePy Help</a></li>
</ul>
</div>
</section>
<section id="spacepy-documents">
<h1>SpacePy Documents<a class="headerlink" href="#spacepy-documents" title="Link to this heading">¶</a></h1>
<p>Further reference material on how to use SpacePy, and examples.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="capabilities.html">SpacePy Capabilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="case_studies.html">SpacePy Case Studies</a></li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publication List</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">SpacePy Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripts.html">SpacePy Scripts</a></li>
</ul>
</div>
</section>
<section id="additional-user-documentation">
<h1>Additional User Documentation<a class="headerlink" href="#additional-user-documentation" title="Link to this heading">¶</a></h1>
<p>In-depth usage focused information for specific modules and tasks. See
also <a class="reference internal" href="#module-reference"><span class="std std-ref">SpacePy Module Reference</span></a> for documentation of the API for each
module.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="coordinates.html">Coordinates - Implementation of Coords class functions for coordinate transformations</a></li>
<li class="toctree-l1"><a class="reference internal" href="datamodel.html">Datamodel</a></li>
<li class="toctree-l1"><a class="reference internal" href="omni.html">OMNI</a></li>
<li class="toctree-l1"><a class="reference internal" href="pybats.html">PyBats - SWMF & BATS-R-US Analysis Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="pycdf.html">pycdf - Python interface to CDF files</a></li>
<li class="toctree-l1"><a class="reference internal" href="time.html">time - Time conversion, manipulation and implementation of Ticktock class</a></li>
</ul>
</div>
</section>
<section id="developer-guide">
<h1>Developer Guide<a class="headerlink" href="#developer-guide" title="Link to this heading">¶</a></h1>
<p>For those developing SpacePy, plus tips for all Python developers.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pythonic.html">Writing Pythonic Code</a></li>
<li class="toctree-l1"><a class="reference internal" href="tips.html">SpacePy Python Programming Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="dep_versions.html">Dependency version support</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc_standard.html">Documentation Standard</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Unit tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci.html">Continuous Integration</a></li>
</ul>
</div>
</section>
<section id="spacepy-module-reference">
<span id="module-reference"></span><h1>SpacePy Module Reference<a class="headerlink" href="#spacepy-module-reference" title="Link to this heading">¶</a></h1>
<p>Description of all functions within SpacePy, by module.</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.html#module-spacepy" title="spacepy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spacepy</span></code></a></p></td>
<td><p>SpacePy: Space Science Tools for Python</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.ae9ap9.html#module-spacepy.ae9ap9" title="spacepy.ae9ap9"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ae9ap9</span></code></a></p></td>
<td><p>Module for reading and dealing with AE9AP9 data files.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.coordinates.html#module-spacepy.coordinates" title="spacepy.coordinates"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coordinates</span></code></a></p></td>
<td><p>Implementation of Coords class functions for coordinate transformations</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.ctrans.html#module-spacepy.ctrans" title="spacepy.ctrans"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ctrans</span></code></a></p></td>
<td><p>CTrans: Module for backend coordinate transformations in SpacePy</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.datamanager.html#module-spacepy.datamanager" title="spacepy.datamanager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datamanager</span></code></a></p></td>
<td><p>Tools for manipulating paths, data, and subsets</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.datamodel.html#module-spacepy.datamodel" title="spacepy.datamodel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datamodel</span></code></a></p></td>
<td><p>Data model conceptually similar to HDF5 and CDF.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.empiricals.html#module-spacepy.empiricals" title="spacepy.empiricals"><code class="xref py py-obj docutils literal notranslate"><span class="pre">empiricals</span></code></a></p></td>
<td><p>Module with some useful empirical models (plasmapause, magnetopause, Lmax)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.irbempy.html#module-spacepy.irbempy" title="spacepy.irbempy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">irbempy</span></code></a></p></td>
<td><p>Wrapper for the fortran library irbem_lib</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.igrf.html#module-spacepy.igrf" title="spacepy.igrf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">igrf</span></code></a></p></td>
<td><p>International Geomagnetic Reference Field model</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.LANLstar.html#module-spacepy.LANLstar" title="spacepy.LANLstar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LANLstar</span></code></a></p></td>
<td><p>Lstar and Lmax calculation using artificial neural network (ANN) technique.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.lib.html#module-spacepy.lib" title="spacepy.lib"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lib</span></code></a></p></td>
<td><p>Support for fast C-based versions of spacepy routines.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.omni.html#module-spacepy.omni" title="spacepy.omni"><code class="xref py py-obj docutils literal notranslate"><span class="pre">omni</span></code></a></p></td>
<td><p>Tools to read and process omni data (Qin-Denton, etc.)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.plot.html#module-spacepy.plot" title="spacepy.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot</span></code></a></p></td>
<td><p>plot: SpacePy plotting routines</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.poppy.html#module-spacepy.poppy" title="spacepy.poppy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">poppy</span></code></a></p></td>
<td><p>PoPPy -- Point Processes in Python.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.pybats.html#module-spacepy.pybats" title="spacepy.pybats"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pybats</span></code></a></p></td>
<td><p>Module for reading, manipulating, and visualizing BATS-R-US and SWMF output.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.pycdf.html#module-spacepy.pycdf" title="spacepy.pycdf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pycdf</span></code></a></p></td>
<td><p>Interface to the Common Data Format (CDF) library</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.seapy.html#module-spacepy.seapy" title="spacepy.seapy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seapy</span></code></a></p></td>
<td><p>SeaPy -- Superposed Epoch in Python.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="autosummary/spacepy.time.html#module-spacepy.time" title="spacepy.time"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time</span></code></a></p></td>
<td><p>Time conversion, manipulation and implementation of Ticktock class</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="autosummary/spacepy.toolbox.html#module-spacepy.toolbox" title="spacepy.toolbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">toolbox</span></code></a></p></td>
<td><p>Toolbox of various functions and generic utilities.</p></td>
</tr>
</tbody>
</table>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
<hr class="docutils" />
<dl class="field-list simple">
<dt class="field-odd">Release<span class="colon">:</span></dt>
<dd class="field-odd"><p>0.7.0</p>
</dd>
<dt class="field-even">Doc generation date<span class="colon">:</span></dt>
<dd class="field-even"><p>Nov 08, 2024</p>
</dd>
</dl>
</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="#">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<div>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">SpacePy 0.7.0 documentation</a></li>
<li><a class="reference internal" href="#getting-started">Getting Started</a></li>
<li><a class="reference internal" href="#spacepy-documents">SpacePy Documents</a></li>
<li><a class="reference internal" href="#additional-user-documentation">Additional User Documentation</a></li>
<li><a class="reference internal" href="#developer-guide">Developer Guide</a></li>
<li><a class="reference internal" href="#spacepy-module-reference">SpacePy Module Reference</a><ul>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="install.html"
title="next chapter">Installing SpacePy</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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="install.html" title="Installing SpacePy"
>next</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="#">documentation </a> »</li>
<li class="nav-item nav-item-this"><a href="">SpacePy 0.7.0 documentation</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>