-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathscripts.html
165 lines (151 loc) · 7.69 KB
/
scripts.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
<!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 Scripts — 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="Coordinates - Implementation of Coords class functions for coordinate transformations" href="coordinates.html" />
<link rel="prev" title="SpacePy Configuration" href="configuration.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="coordinates.html" title="Coordinates - Implementation of Coords class functions for coordinate transformations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="configuration.html" title="SpacePy Configuration"
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-this"><a href="">SpacePy Scripts</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="spacepy-scripts">
<h1>SpacePy Scripts<a class="headerlink" href="#spacepy-scripts" title="Link to this heading">¶</a></h1>
<p>Some scripts using SpacePy are included in the <code class="docutils literal notranslate"><span class="pre">scripts</span></code> directory
of the source distribution. At the moment they are not installed by
the installer.</p>
<section id="istp-checks-py">
<h2>istp_checks.py<a class="headerlink" href="#istp-checks-py" title="Link to this heading">¶</a></h2>
<p>Checks for various ISTP compliance issues in a file and prints any
issues found. This script is supplemental to the checker included with
the <a class="reference external" href="https://spdf.gsfc.nasa.gov/skteditor/">ISTP skeleton editor</a>;
it primarily checks for errors that the skeleton editor does not.</p>
<p>Badly noncompliant files generally result in the error “Test x did not
complete”. This means the test crashed due to some failure in the
assumptions about the CDF structure. Please run the individual test to
get a traceback and <a class="reference external" href="https://github.com/spacepy/spacepy/issues">open an issue</a>.</p>
<p>This is just a thin wrapper to
<a class="reference internal" href="autosummary/spacepy.pycdf.istp.FileChecks.html#spacepy.pycdf.istp.FileChecks.all" title="spacepy.pycdf.istp.FileChecks.all"><code class="xref py py-meth docutils literal notranslate"><span class="pre">spacepy.pycdf.istp.FileChecks.all()</span></code></a>; that documentation (plus
other methods in the class) describes the actual checks.</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-istp_checks.py-arg-cdffile">
<span class="sig-name descname"><span class="pre">cdffile</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-istp_checks.py-arg-cdffile" title="Link to this definition">¶</a></dt>
<dd><p>Name of the CDF file to check (required)</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="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="#">SpacePy Scripts</a><ul>
<li><a class="reference internal" href="#istp-checks-py">istp_checks.py</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="configuration.html"
title="previous chapter">SpacePy Configuration</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="coordinates.html"
title="next chapter">Coordinates - Implementation of Coords class functions for coordinate transformations</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/scripts.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="coordinates.html" title="Coordinates - Implementation of Coords class functions for coordinate transformations"
>next</a> |</li>
<li class="right" >
<a href="configuration.html" title="SpacePy Configuration"
>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-this"><a href="">SpacePy Scripts</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>