-updated API doc

cghoffmann · Jan 30, 2020 · e807dce · e807dce
1 parent 8047248
commit e807dce
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 2 deletions.
diff --git a/docs/_modules/mjoindices/omi/omi_calculator.html b/docs/_modules/mjoindices/omi/omi_calculator.html
@@ -396,7 +396,7 @@ <h1>Source code for mjoindices.omi.omi_calculator</h1><div class="highlight"><pr
         <span class="n">F</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">olr_maps_for_doy</span><span class="p">,</span>
                        <span class="p">[</span><span class="n">N</span><span class="p">,</span> <span class="n">M</span><span class="p">])</span><span class="o">.</span><span class="n">T</span>  <span class="c1"># vector: only one dimension. Length given by original longitude and latitude bins</span>
         <span class="n">solver</span> <span class="o">=</span> <span class="n">eofs_package</span><span class="o">.</span><span class="n">Eof</span><span class="p">(</span><span class="n">F</span><span class="o">.</span><span class="n">T</span><span class="p">)</span>
-        <span class="c1"># Todo: Shpuld we care about complex values here?</span>
+        <span class="c1"># Todo: Should we care about complex values here?</span>
         <span class="n">eofs</span> <span class="o">=</span> <span class="n">solver</span><span class="o">.</span><span class="n">eofs</span><span class="p">(</span><span class="n">neofs</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
         <span class="n">explainedVariances</span> <span class="o">=</span> <span class="n">solver</span><span class="o">.</span><span class="n">varianceFraction</span><span class="p">()</span>
         <span class="n">L</span> <span class="o">=</span> <span class="n">solver</span><span class="o">.</span><span class="n">eigenvalues</span><span class="p">()</span>

diff --git a/docs/_modules/mjoindices/principal_components.html b/docs/_modules/mjoindices/principal_components.html
@@ -228,7 +228,6 @@ <h1>Source code for mjoindices.principal_components</h1><div class="highlight"><
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pc2</span>
 
-    <span class="c1"># ToDo: implement also storing to npz file</span>
 <div class="viewcode-block" id="PCData.save_pcs_to_txt_file"><a class="viewcode-back" href="../../api/principal_components.html#mjoindices.principal_components.PCData.save_pcs_to_txt_file">[docs]</a>    <span class="k">def</span> <span class="nf">save_pcs_to_txt_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Saves the computed PCs to a text file.</span>