Skip to content

Commit 1e6009a

Browse files
committed
update docs, README, CITATION to include new JOSS paper
1 parent ddd97e8 commit 1e6009a

File tree

5 files changed

+12
-17
lines changed

5 files changed

+12
-17
lines changed

docs/_sources/about.rst.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
📖 About
22
=========
33

4-
SounderPy: A sounding visualization tool for severe-weather analysis and forecasting
4+
SounderPy: An atmospheric sounding visualization and analysis tool for Python
55
--------------------------------------------------------------------------------------
66

77

@@ -27,6 +27,7 @@ novices. A number of scientific Python libraries build the base of SounderPy’s
2727
durable functionality, such as NumPy, Matplotlib, xarray, Metpy, and SHARPpy. SounderPy is
2828
available through GitHub and PyPi and is distributed under an MIT license.
2929

30+
Read more about SounderPy in this article published in the Journal of Open Source Software: `SounderPy: An atmospheric sounding visualization and analysis tool for Python <https://doi.org/10.21105/joss.08087>`_.
3031

3132
.. image:: _static/images/sounderpy_poster.png
3233
:width: 500 px
@@ -117,13 +118,12 @@ Authors and Contributors
117118

118119
Citing SounderPy
119120
-----------------
120-
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10443609.svg
121-
:target: https://doi.org/10.5281/zenodo.10443609
122-
:alt: DOI
121+
.. image:: https://joss.theoj.org/papers/10.21105/joss.08087/status.svg
122+
:target: https://doi.org/10.21105/joss.08087
123123

124124

125125
in AMS format:
126-
Gillett, K., 2025: SounderPy: Vertical Profile Data Retrieval & Analysis Tool for Python (Version 3.0.8). Py-Pi, https://pypi.org/project/sounderpy/
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
127127

128128

129129
***************************************************************

docs/about.html

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<p class="caption" role="heading"><span class="caption-text">General:</span></p>
5050
<ul class="current">
5151
<li class="toctree-l1 current"><a class="current reference internal" href="#">📖 About</a><ul>
52-
<li class="toctree-l2"><a class="reference internal" href="#sounderpy-a-sounding-visualization-tool-for-severe-weather-analysis-and-forecasting">SounderPy: A sounding visualization tool for severe-weather analysis and forecasting</a></li>
52+
<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>
5353
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
5454
<li class="toctree-l2"><a class="reference internal" href="#sample-basic-use">Sample Basic Use</a></li>
5555
<li class="toctree-l2"><a class="reference internal" href="#authors-and-contributors">Authors and Contributors</a></li>
@@ -103,8 +103,8 @@
103103

104104
<section id="about">
105105
<h1>📖 About<a class="headerlink" href="#about" title="Link to this heading"></a></h1>
106-
<section id="sounderpy-a-sounding-visualization-tool-for-severe-weather-analysis-and-forecasting">
107-
<h2>SounderPy: A sounding visualization tool for severe-weather analysis and forecasting<a class="headerlink" href="#sounderpy-a-sounding-visualization-tool-for-severe-weather-analysis-and-forecasting" title="Link to this heading"></a></h2>
106+
<section id="sounderpy-an-atmospheric-sounding-visualization-and-analysis-tool-for-python">
107+
<h2>SounderPy: An atmospheric sounding visualization and analysis tool for Python<a class="headerlink" href="#sounderpy-an-atmospheric-sounding-visualization-and-analysis-tool-for-python" title="Link to this heading"></a></h2>
108108
<a class="reference internal image-reference" href="_images/example-sounding_light4.png"><img alt="_images/example-sounding_light4.png" class="align-center" src="_images/example-sounding_light4.png" style="width: 500px;" />
109109
</a>
110110
<hr class="docutils" />
@@ -122,6 +122,7 @@ <h2>SounderPy: A sounding visualization tool for severe-weather analysis and for
122122
novices. A number of scientific Python libraries build the base of SounderPy’s efficient and
123123
durable functionality, such as NumPy, Matplotlib, xarray, Metpy, and SHARPpy. SounderPy is
124124
available through GitHub and PyPi and is distributed under an MIT license.</p>
125+
<p>Read more about SounderPy in this article published in the Journal of Open Source Software: <a class="reference external" href="https://doi.org/10.21105/joss.08087">SounderPy: An atmospheric sounding visualization and analysis tool for Python</a>.</p>
125126
<a class="reference internal image-reference" href="_images/sounderpy_poster.png"><img alt="_images/sounderpy_poster.png" class="align-center" src="_images/sounderpy_poster.png" style="width: 500px;" />
126127
</a>
127128
<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>
@@ -185,13 +186,7 @@ <h2>Authors and Contributors<a class="headerlink" href="#authors-and-contributor
185186
<section id="citing-sounderpy">
186187
<h2>Citing SounderPy<a class="headerlink" href="#citing-sounderpy" title="Link to this heading"></a></h2>
187188
<blockquote>
188-
<div><a class="reference external image-reference" href="https://doi.org/10.5281/zenodo.10443609"><img alt="DOI" src="https://zenodo.org/badge/DOI/10.5281/zenodo.10443609.svg" />
189-
</a>
190-
<dl class="simple">
191-
<dt>in AMS format:</dt><dd><p>Gillett, K., 2025: SounderPy: Vertical Profile Data Retrieval &amp; Analysis Tool for Python (Version 3.0.8). Py-Pi, <a class="reference external" href="https://pypi.org/project/sounderpy/">https://pypi.org/project/sounderpy/</a></p>
192-
</dd>
193-
</dl>
194-
</div></blockquote>
189+
<div></div></blockquote>
195190
</section>
196191
<hr class="docutils" />
197192
<section id="references">

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h1>Directory<a class="headerlink" href="#directory" title="Link to this heading
210210
<p class="caption" role="heading"><span class="caption-text">General:</span></p>
211211
<ul>
212212
<li class="toctree-l1"><a class="reference internal" href="about.html">📖 About</a><ul>
213-
<li class="toctree-l2"><a class="reference internal" href="about.html#sounderpy-a-sounding-visualization-tool-for-severe-weather-analysis-and-forecasting">SounderPy: A sounding visualization tool for severe-weather analysis and forecasting</a></li>
213+
<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>
214214
<li class="toctree-l2"><a class="reference internal" href="about.html#installation">Installation</a></li>
215215
<li class="toctree-l2"><a class="reference internal" href="about.html#sample-basic-use">Sample Basic Use</a></li>
216216
<li class="toctree-l2"><a class="reference internal" href="about.html#authors-and-contributors">Authors and Contributors</a></li>

docs/objects.inv

7 Bytes
Binary file not shown.

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.

0 commit comments

Comments
 (0)