Skip to content

Commit f9d4466

Browse files
kylejgillettkylejgillett
committed
Update docs
1 parent 8b497f9 commit f9d4466

9 files changed

Lines changed: 69 additions & 60 deletions

‎docs/_sources/about.rst.txt‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,33 @@ SounderPy has been used by several institutions. For example, this tool has been
4242

4343
☕ SounderPy is an open-source package developed on my own time. If you would you like to support continued SounderPy development, consider "`Buying me a coffee <https://www.buymeacoffee.com/kylejgillett>`_"! ☕
4444

45+
46+
Citing SounderPy
47+
-----------------
48+
49+
To cite this package, please cite `SounderPy's JOSS article <https://doi.org/10.21105/joss.08087>`_ in AMS format (or BibTeX via github):
50+
51+
Gillett, K. J., 2025: SounderPy: An atmospheric sounding visualization and analysis tool for Python. J. Open Source Software, 10 (112), 8087, https://doi.org/10.21105/joss.08087
52+
53+
.. image:: https://joss.theoj.org/papers/10.21105/joss.08087/status.svg
54+
:target: https://doi.org/10.21105/joss.08087
55+
56+
***************************************************************
57+
58+
59+
Authors and Contributors
60+
-------------------------
61+
**AUTHOR: Kyle J Gillett, University of North Dakota**
62+
63+
*CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing*
64+
*CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library*
65+
*CONTRIBUTOR: Daryl Herzmann, Iowa State University | SounderPy Feedstock for conda-forge*
66+
*CONTRIBUTOR: Ryan Vandersmith | Stepwise CAPE/CIN plot*
67+
*CONTRIBUTOR: David E Levin, NOAA/NWS | Alaskan RAOB site IDs*
68+
69+
***************************************************************
70+
71+
4572
Installation
4673
------------
4774

@@ -104,31 +131,6 @@ More examples of these plots are available :ref:`here<gallery>`
104131
***************************************************************
105132

106133

107-
108-
Authors and Contributors
109-
-------------------------
110-
**AUTHOR: Kyle J Gillett, University of North Dakota**
111-
112-
*CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing*
113-
*CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library*
114-
*CONTRIBUTOR: Daryl Herzmann, Iowa State University | SounderPy Feedstock for conda-forge*
115-
*CONTRIBUTOR: Ryan Vandersmith | Stepwise CAPE/CIN plot*
116-
117-
***************************************************************
118-
119-
Citing SounderPy
120-
-----------------
121-
.. image:: https://joss.theoj.org/papers/10.21105/joss.08087/status.svg
122-
:target: https://doi.org/10.21105/joss.08087
123-
124-
125-
in AMS format:
126-
Gillett, K. J., 2025: SounderPy: An atmospheric sounding visualization and analysis tool for Python. J. Open Source Software, 10 (112), 8087, https://doi.org/10.21105/joss.08087
127-
128-
129-
***************************************************************
130-
131-
132134
References
133135
----------
134136

‎docs/_sources/gettingdata.rst.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Observed Data | RAOB & IGRAv2
252252
253253
Return a ``dict`` of 'cleaned up' observed profile data
254254

255-
:param station: may be a three digit RAOB identifier (such as: 'DTX'), 5 digit WMO identifier (such as: '72317'), or 11 digit IGRAv2 identifier (such as: 'GMM00010393')
255+
:param station: may be a 3-4 digit ICAO identifier (such as: 'DTX' or 'KDTX'), 5 digit WMO identifier (such as: '72317'), or 11 digit IGRAv2 identifier (such as: 'GMM00010393').
256256
:type station: str, required
257257
:param year: launch year
258258
:type year: str, required
@@ -272,6 +272,8 @@ Observed Data | RAOB & IGRAv2
272272
.. note::
273273
Some data in these archives may be missing, incomplete or on occasion mislabled. If you can't find a RAOB you know for sure exists, try increasing or decreasing the launch_hour by 1 hour.
274274

275+
.. note::
276+
Some ICAO identifiers have the same "3-digt" suffix, such as "PABR" & "KABR", its recommended to always use the 4 digit identifier to get the correct station.
275277

276278
.. _raobsites:
277279

‎docs/_sources/troubleshooting.rst.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can test your installation of SounderPy against this figure. To do so, run t
2121
2222
import sounderpy as spy
2323
24-
data = spy.get_obs_data("abr", "2024", "08", "29", "00")
24+
data = spy.get_obs_data("kabr", "2024", "08", "29", "00")
2525
2626
spy.build_sounding(data, color_blind=True, radar='single')
2727

‎docs/about.html‎

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@
5050
<ul class="current">
5151
<li class="toctree-l1 current"><a class="current reference internal" href="#">📖 About</a><ul>
5252
<li class="toctree-l2"><a class="reference internal" href="#sounderpy-an-atmospheric-sounding-visualization-and-analysis-tool-for-python">SounderPy: An atmospheric sounding visualization and analysis tool for Python</a></li>
53+
<li class="toctree-l2"><a class="reference internal" href="#citing-sounderpy">Citing SounderPy</a></li>
54+
<li class="toctree-l2"><a class="reference internal" href="#authors-and-contributors">Authors and Contributors</a></li>
5355
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
5456
<li class="toctree-l2"><a class="reference internal" href="#sample-basic-use">Sample Basic Use</a></li>
55-
<li class="toctree-l2"><a class="reference internal" href="#authors-and-contributors">Authors and Contributors</a></li>
56-
<li class="toctree-l2"><a class="reference internal" href="#citing-sounderpy">Citing SounderPy</a></li>
5757
<li class="toctree-l2"><a class="reference internal" href="#references">References</a></li>
5858
<li class="toctree-l2"><a class="reference internal" href="#about-the-author">About the Author</a></li>
5959
<li class="toctree-l2"><a class="reference internal" href="#useful-links">Useful Links</a></li>
@@ -128,6 +128,32 @@ <h2>SounderPy: An atmospheric sounding visualization and analysis tool for Pytho
128128
<br><p>SounderPy has been used by several institutions. For example, this tool has been implemented by the Des Moines, Columbia, Grand Forks, Little Rock, Omaha, &amp; Grand Rapids National Weather Service Offices; the State University of New York at Albany, Mississippi State University, the University of North Dakota, and others. Many students at various universities have used SounderPy in projects, posters, and papers, such as students at The University of Oklahoma, Ohio State University, Central Michigan University, Iowa State University, Texas A&amp;M University, &amp; Rizal Technological University.</p>
129129
<p>☕ SounderPy is an open-source package developed on my own time. If you would you like to support continued SounderPy development, consider “<a class="reference external" href="https://www.buymeacoffee.com/kylejgillett">Buying me a coffee</a>”! ☕</p>
130130
</section>
131+
<section id="citing-sounderpy">
132+
<h2>Citing SounderPy<a class="headerlink" href="#citing-sounderpy" title="Link to this heading"></a></h2>
133+
<blockquote>
134+
<div><p>To cite this package, please cite <a class="reference external" href="https://doi.org/10.21105/joss.08087">SounderPy’s JOSS article</a> in AMS format (or BibTeX via github):</p>
135+
<blockquote>
136+
<div><p>Gillett, K. J., 2025: SounderPy: An atmospheric sounding visualization and analysis tool for Python. J. Open Source Software, 10 (112), 8087, <a class="reference external" href="https://doi.org/10.21105/joss.08087">https://doi.org/10.21105/joss.08087</a></p>
137+
</div></blockquote>
138+
<a class="reference external image-reference" href="https://doi.org/10.21105/joss.08087"><img alt="https://joss.theoj.org/papers/10.21105/joss.08087/status.svg" src="https://joss.theoj.org/papers/10.21105/joss.08087/status.svg" />
139+
</a>
140+
</div></blockquote>
141+
</section>
142+
<hr class="docutils" />
143+
<section id="authors-and-contributors">
144+
<h2>Authors and Contributors<a class="headerlink" href="#authors-and-contributors" title="Link to this heading"></a></h2>
145+
<blockquote>
146+
<div><p><strong>AUTHOR: Kyle J Gillett, University of North Dakota</strong></p>
147+
<blockquote>
148+
<div><p><em>CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing</em>
149+
<em>CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library</em>
150+
<em>CONTRIBUTOR: Daryl Herzmann, Iowa State University | SounderPy Feedstock for conda-forge</em>
151+
<em>CONTRIBUTOR: Ryan Vandersmith | Stepwise CAPE/CIN plot</em></p>
152+
</div></blockquote>
153+
<p><em>CONTRIBUTOR: David E Levin, NOAA/NWS | Alaskan RAOB site IDs</em></p>
154+
</div></blockquote>
155+
</section>
156+
<hr class="docutils" />
131157
<section id="installation">
132158
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
133159
<p>SounderPy is available on PyPi and can be installed via <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
@@ -172,31 +198,6 @@ <h2>Sample Basic Use<a class="headerlink" href="#sample-basic-use" title="Link t
172198
<p>More examples of these plots are available <span class="xref std std-ref">here</span></p>
173199
</section>
174200
<hr class="docutils" />
175-
<section id="authors-and-contributors">
176-
<h2>Authors and Contributors<a class="headerlink" href="#authors-and-contributors" title="Link to this heading"></a></h2>
177-
<blockquote>
178-
<div><p><strong>AUTHOR: Kyle J Gillett, University of North Dakota</strong></p>
179-
<blockquote>
180-
<div><p><em>CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing</em>
181-
<em>CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library</em>
182-
<em>CONTRIBUTOR: Daryl Herzmann, Iowa State University | SounderPy Feedstock for conda-forge</em>
183-
<em>CONTRIBUTOR: Ryan Vandersmith | Stepwise CAPE/CIN plot</em></p>
184-
</div></blockquote>
185-
</div></blockquote>
186-
</section>
187-
<hr class="docutils" />
188-
<section id="citing-sounderpy">
189-
<h2>Citing SounderPy<a class="headerlink" href="#citing-sounderpy" title="Link to this heading"></a></h2>
190-
<blockquote>
191-
<div><a class="reference external image-reference" href="https://doi.org/10.21105/joss.08087"><img alt="https://joss.theoj.org/papers/10.21105/joss.08087/status.svg" src="https://joss.theoj.org/papers/10.21105/joss.08087/status.svg" />
192-
</a>
193-
<dl class="simple">
194-
<dt>in AMS format:</dt><dd><p>Gillett, K. J., 2025: SounderPy: An atmospheric sounding visualization and analysis tool for Python. J. Open Source Software, 10 (112), 8087, <a class="reference external" href="https://doi.org/10.21105/joss.08087">https://doi.org/10.21105/joss.08087</a></p>
195-
</dd>
196-
</dl>
197-
</div></blockquote>
198-
</section>
199-
<hr class="docutils" />
200201
<section id="references">
201202
<h2>References<a class="headerlink" href="#references" title="Link to this heading"></a></h2>
202203
<blockquote>

‎docs/gettingdata.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ <h1>🌐 Tools for Getting Data<a class="headerlink" href="#tools-for-getting-da
383383
<dl class="field-list simple">
384384
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
385385
<dd class="field-odd"><ul class="simple">
386-
<li><p><strong>station</strong> (<em>str</em><em>, </em><em>required</em>) – may be a three digit RAOB identifier (such as: ‘DTX’), 5 digit WMO identifier (such as: ‘72317’), or 11 digit IGRAv2 identifier (such as: ‘GMM00010393’)</p></li>
386+
<li><p><strong>station</strong> (<em>str</em><em>, </em><em>required</em>) – may be a 3-4 digit ICAO identifier (such as: ‘DTX’ or ‘KDTX’), 5 digit WMO identifier (such as: ‘72317’), or 11 digit IGRAv2 identifier (such as: ‘GMM00010393’).</p></li>
387387
<li><p><strong>year</strong> (<em>str</em><em>, </em><em>required</em>) – launch year</p></li>
388388
<li><p><strong>month</strong> (<em>str</em><em>, </em><em>required</em>) – launch month</p></li>
389389
<li><p><strong>day</strong> (<em>str</em><em>, </em><em>required</em>) – launch day</p></li>
@@ -405,6 +405,10 @@ <h1>🌐 Tools for Getting Data<a class="headerlink" href="#tools-for-getting-da
405405
<p class="admonition-title">Note</p>
406406
<p>Some data in these archives may be missing, incomplete or on occasion mislabled. If you can’t find a RAOB you know for sure exists, try increasing or decreasing the launch_hour by 1 hour.</p>
407407
</div>
408+
<div class="admonition note">
409+
<p class="admonition-title">Note</p>
410+
<p>Some ICAO identifiers have the same “3-digt” suffix, such as “PABR” &amp; “KABR”, its recommended to always use the 4 digit identifier to get the correct station.</p>
411+
</div>
408412
<section id="available-raob-sites">
409413
<span id="raobsites"></span><h3>Available RAOB Sites:<a class="headerlink" href="#available-raob-sites" title="Link to this heading"></a></h3>
410414
<embed>

‎docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,10 +211,10 @@ <h1>Directory<a class="headerlink" href="#directory" title="Link to this heading
211211
<ul>
212212
<li class="toctree-l1"><a class="reference internal" href="about.html">📖 About</a><ul>
213213
<li class="toctree-l2"><a class="reference internal" href="about.html#sounderpy-an-atmospheric-sounding-visualization-and-analysis-tool-for-python">SounderPy: An atmospheric sounding visualization and analysis tool for Python</a></li>
214+
<li class="toctree-l2"><a class="reference internal" href="about.html#citing-sounderpy">Citing SounderPy</a></li>
215+
<li class="toctree-l2"><a class="reference internal" href="about.html#authors-and-contributors">Authors and Contributors</a></li>
214216
<li class="toctree-l2"><a class="reference internal" href="about.html#installation">Installation</a></li>
215217
<li class="toctree-l2"><a class="reference internal" href="about.html#sample-basic-use">Sample Basic Use</a></li>
216-
<li class="toctree-l2"><a class="reference internal" href="about.html#authors-and-contributors">Authors and Contributors</a></li>
217-
<li class="toctree-l2"><a class="reference internal" href="about.html#citing-sounderpy">Citing SounderPy</a></li>
218218
<li class="toctree-l2"><a class="reference internal" href="about.html#references">References</a></li>
219219
<li class="toctree-l2"><a class="reference internal" href="about.html#about-the-author">About the Author</a></li>
220220
<li class="toctree-l2"><a class="reference internal" href="about.html#useful-links">Useful Links</a></li>

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/troubleshooting.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h2>Testing SounderPy<a class="headerlink" href="#testing-sounderpy" title="Link
112112
</a>
113113
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sounderpy</span> <span class="k">as</span> <span class="nn">spy</span>
114114

115-
<span class="n">data</span> <span class="o">=</span> <span class="n">spy</span><span class="o">.</span><span class="n">get_obs_data</span><span class="p">(</span><span class="s2">&quot;abr&quot;</span><span class="p">,</span> <span class="s2">&quot;2024&quot;</span><span class="p">,</span> <span class="s2">&quot;08&quot;</span><span class="p">,</span> <span class="s2">&quot;29&quot;</span><span class="p">,</span> <span class="s2">&quot;00&quot;</span><span class="p">)</span>
115+
<span class="n">data</span> <span class="o">=</span> <span class="n">spy</span><span class="o">.</span><span class="n">get_obs_data</span><span class="p">(</span><span class="s2">&quot;kabr&quot;</span><span class="p">,</span> <span class="s2">&quot;2024&quot;</span><span class="p">,</span> <span class="s2">&quot;08&quot;</span><span class="p">,</span> <span class="s2">&quot;29&quot;</span><span class="p">,</span> <span class="s2">&quot;00&quot;</span><span class="p">)</span>
116116

117117
<span class="n">spy</span><span class="o">.</span><span class="n">build_sounding</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">color_blind</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">radar</span><span class="o">=</span><span class="s1">&#39;single&#39;</span><span class="p">)</span>
118118
</pre></div>

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "sounderpy"
7-
version = "3.1.0"
7+
version = "3.1.0dev1"
88
authors = [
99
{ name="Kyle J Gillett, University of North Dakota", email="kyle.gillett@und.edu" },
1010
]

0 commit comments

Comments
 (0)