Skip to content

Commit 2b8c8ba

Browse files
committed
update docs
1 parent e9d1577 commit 2b8c8ba

File tree

3 files changed

+26
-18
lines changed

3 files changed

+26
-18
lines changed

docs/_sources/about.rst.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ or via ``conda forge`` by first setting up the ``conda-forge`` channel:
6060
6161
then you can install sounderpy via:
6262

63-
.. code-block:: console
63+
.. code-block:: console
6464
6565
conda install sounderpy
6666

@@ -88,9 +88,9 @@ SounderPy is designed for simple and efficient use for all users. Below is a bas
8888

8989
.. code-block:: python
9090
91-
import sounderpy as spy
92-
clean_data = spy.get_bufkit_data('hrrr', 'kmli', 8, '2023', '03', '31', '12')
93-
spy.build_sounding(clean_data)
91+
import sounderpy as spy
92+
clean_data = spy.get_bufkit_data('hrrr', 'kmli', 8, '2023', '03', '31', '12')
93+
spy.build_sounding(clean_data)
9494
9595
Those three basic lines will make this!:
9696

@@ -107,7 +107,7 @@ More examples of these plots are available :ref:`here<gallery>`
107107

108108
Authors and Contributors
109109
-------------------------
110-
**AUTHOR: Kyle J Gillett, University of North Dakota**
110+
**AUTHOR: Kyle J Gillett, University of North Dakota**
111111

112112
*CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing*
113113
*CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library*
@@ -119,11 +119,11 @@ Authors and Contributors
119119
Citing SounderPy
120120
-----------------
121121
.. image:: https://joss.theoj.org/papers/10.21105/joss.08087/status.svg
122-
:target: https://doi.org/10.21105/joss.08087
122+
:target: https://doi.org/10.21105/joss.08087
123123

124124

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
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
127127

128128

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

docs/about.html

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -143,16 +143,16 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
143143
</pre></div>
144144
</div>
145145
<p>then you can install sounderpy via:</p>
146-
<blockquote>
147-
<div><div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">conda install sounderpy</span>
148-
</pre></div>
149-
</div>
150-
<p>or</p>
151-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">mamba install sounderpy</span>
146+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go"> conda install sounderpy</span>
147+
148+
<span class="go">or</span>
149+
150+
<span class="go">.. code-block:: console</span>
151+
152+
<span class="go"> mamba install sounderpy</span>
152153
</pre></div>
153154
</div>
154155
</div></blockquote>
155-
</div></blockquote>
156156
<p>In your Python document, its fun to import SounderPy as <code class="docutils literal notranslate"><span class="pre">spy</span></code>!:</p>
157157
<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>
158158
</pre></div>
@@ -176,17 +176,25 @@ <h2>Sample Basic Use<a class="headerlink" href="#sample-basic-use" title="Link t
176176
<h2>Authors and Contributors<a class="headerlink" href="#authors-and-contributors" title="Link to this heading"></a></h2>
177177
<blockquote>
178178
<div><p><strong>AUTHOR: Kyle J Gillett, University of North Dakota</strong></p>
179-
<p><em>CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing</em>
179+
<blockquote>
180+
<div><p><em>CONTRIBUTOR: Scott Thomas, NWS Grand Rapids | VWP Hodograph, Buoy-sites listing</em>
180181
<em>CONTRIBUTOR: Amelia R H Urquhart, University of Oklahoma | ecape-parcels library</em>
181182
<em>CONTRIBUTOR: Daryl Herzmann, Iowa State University | SounderPy Feedstock for conda-forge</em>
182183
<em>CONTRIBUTOR: Ryan Vandersmith | Stepwise CAPE/CIN plot</em></p>
183184
</div></blockquote>
185+
</div></blockquote>
184186
</section>
185187
<hr class="docutils" />
186188
<section id="citing-sounderpy">
187189
<h2>Citing SounderPy<a class="headerlink" href="#citing-sounderpy" title="Link to this heading"></a></h2>
188190
<blockquote>
189-
<div></div></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>
190198
</section>
191199
<hr class="docutils" />
192200
<section id="references">

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)