Skip to content

Commit

Permalink
doc-fix: rst docs fix for #17
Browse files Browse the repository at this point in the history
  • Loading branch information
@hkershaw-brown
hkershaw-brown committed Aug 30, 2024
1 parent a3f5e5b commit b1eceed
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/quickstart.doctree
View file
Binary file not shown.
10 changes: 5 additions & 5 deletions docs/build/html/_sources/quickstart.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Import the obs_sequence and plots module

.. code-block :: python
from pydartdiags.obs_sequence import obs_sequence as obs_seq
from pydartdiags.obs_sequence import obs_sequence as obsq
from pydartdiags.plots import plots
Expand All @@ -29,7 +29,7 @@ Read an observation sequence file into a DataFrama

.. code-block :: python
obs_seq = obs_seq.obs_sequence('obs_seq.final.ascii')
obs_seq = obsq.obs_sequence('obs_seq.final.ascii')
Examine the DataFrame
Expand Down Expand Up @@ -199,7 +199,7 @@ Find the numeber of assimilated (used) observations vs. possible observations by

.. code-block :: python
obs_seq.possible_vs_used(obs_seq.df)
obsq.possible_vs_used(obs_seq.df)
.. raw :: html
Expand Down Expand Up @@ -358,7 +358,7 @@ plot a rank histogram

.. code-block :: python
df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0)
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0)
plots.plot_rank_histogram(df_qc0)
.. image:: images/rankhist.png
Expand All @@ -376,7 +376,7 @@ plot profiles of RMSE and Bias
hPalevels = [0.0, 100.0, 150.0, 200.0, 250.0, 300.0, 400.0, 500.0, 700, 850, 925, 1000] # Pa?
plevels = [i * 100 for i in hPalevels]
df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_profile, figrmse, figbias = plots.plot_profile(df_qc0, plevels)
.. image:: images/rmse.png
Expand Down
10 changes: 5 additions & 5 deletions docs/build/html/quickstart.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
</pre></div>
</div>
<p>Import the obs_sequence and plots module</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pydartdiags.obs_sequence</span> <span class="kn">import</span> <span class="n">obs_sequence</span> <span class="k">as</span> <span class="n">obs_seq</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pydartdiags.obs_sequence</span> <span class="kn">import</span> <span class="n">obs_sequence</span> <span class="k">as</span> <span class="n">obsq</span>
<span class="kn">from</span> <span class="nn">pydartdiags.plots</span> <span class="kn">import</span> <span class="n">plots</span>
</pre></div>
</div>
</section>
<section id="read-an-obs-sequence-file">
<h2>Read an obs_sequence file<a class="headerlink" href="#read-an-obs-sequence-file" title="Link to this heading"></a></h2>
<p>Read an observation sequence file into a DataFrama</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">obs_seq</span> <span class="o">=</span> <span class="n">obs_seq</span><span class="o">.</span><span class="n">obs_sequence</span><span class="p">(</span><span class="s1">&#39;obs_seq.final.ascii&#39;</span><span class="p">)</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">obs_seq</span> <span class="o">=</span> <span class="n">obsq</span><span class="o">.</span><span class="n">obs_sequence</span><span class="p">(</span><span class="s1">&#39;obs_seq.final.ascii&#39;</span><span class="p">)</span>
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -277,7 +277,7 @@ <h2>Examine the DataFrame<a class="headerlink" href="#examine-the-dataframe" tit
</tbody>
</table>
<p>5 rows × 97 columns</p><p>Find the numeber of assimilated (used) observations vs. possible observations by type</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">obs_seq</span><span class="o">.</span><span class="n">possible_vs_used</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">)</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">obsq</span><span class="o">.</span><span class="n">possible_vs_used</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">)</span>
</pre></div>
</div>
<table border="1" class="dataframe">
Expand Down Expand Up @@ -431,7 +431,7 @@ <h2>plot a rank histogram<a class="headerlink" href="#plot-a-rank-histogram" tit
<li><p>Select only observations that were assimilated (QC === 0).</p></li>
<li><p>Plot the rank histogram</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">df_qc0</span> <span class="o">=</span> <span class="n">obs_seq</span><span class="o">.</span><span class="n">select_by_dart_qc</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">df_qc0</span> <span class="o">=</span> <span class="n">obsq</span><span class="o">.</span><span class="n">select_by_dart_qc</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">plots</span><span class="o">.</span><span class="n">plot_rank_histogram</span><span class="p">(</span><span class="n">df_qc0</span><span class="p">)</span>
</pre></div>
</div>
Expand All @@ -447,7 +447,7 @@ <h2>plot profiles of RMSE and Bias<a class="headerlink" href="#plot-profiles-of-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">hPalevels</span> <span class="o">=</span> <span class="p">[</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">100.0</span><span class="p">,</span> <span class="mf">150.0</span><span class="p">,</span> <span class="mf">200.0</span><span class="p">,</span> <span class="mf">250.0</span><span class="p">,</span> <span class="mf">300.0</span><span class="p">,</span> <span class="mf">400.0</span><span class="p">,</span> <span class="mf">500.0</span><span class="p">,</span> <span class="mi">700</span><span class="p">,</span> <span class="mi">850</span><span class="p">,</span> <span class="mi">925</span><span class="p">,</span> <span class="mi">1000</span><span class="p">]</span> <span class="c1"># Pa?</span>
<span class="n">plevels</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span> <span class="o">*</span> <span class="mi">100</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">hPalevels</span><span class="p">]</span>

<span class="n">df_qc0</span> <span class="o">=</span> <span class="n">obs_seq</span><span class="o">.</span><span class="n">select_by_dart_qc</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c1"># only qc 0</span>
<span class="n">df_qc0</span> <span class="o">=</span> <span class="n">obsq</span><span class="o">.</span><span class="n">select_by_dart_qc</span><span class="p">(</span><span class="n">obs_seq</span><span class="o">.</span><span class="n">df</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c1"># only qc 0</span>
<span class="n">df_profile</span><span class="p">,</span> <span class="n">figrmse</span><span class="p">,</span> <span class="n">figbias</span> <span class="o">=</span> <span class="n">plots</span><span class="o">.</span><span class="n">plot_profile</span><span class="p">(</span><span class="n">df_qc0</span><span class="p">,</span> <span class="n">plevels</span><span class="p">)</span>
</pre></div>
</div>
Expand Down
Loading

0 comments on commit b1eceed

Please sign in to comment.