Skip to content

Commit c76c8ab

Browse files
committed
Deploying to gh-pages from @ 5fb2494 🚀
1 parent d343ecb commit c76c8ab

File tree

5 files changed

+13
-9
lines changed

5 files changed

+13
-9
lines changed

_modules/cfapyx/backend.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h1>Source code for cfapyx.backend</h1><div class="highlight"><pre>
109109
<span class="k">def</span><span class="w"> </span><span class="nf">open_cfa_dataset</span><span class="p">(</span>
110110
<span class="n">filename_or_obj</span><span class="p">,</span>
111111
<span class="n">drop_variables</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
112-
<span class="n">mask_and_scale</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
112+
<span class="n">mask_and_scale</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
113113
<span class="n">decode_times</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
114114
<span class="n">concat_characters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
115115
<span class="n">decode_coords</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
@@ -180,7 +180,7 @@ <h1>Source code for cfapyx.backend</h1><div class="highlight"><pre>
180180
<span class="n">filename_or_obj</span><span class="p">,</span>
181181
<span class="o">*</span><span class="p">,</span>
182182
<span class="n">drop_variables</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
183-
<span class="n">mask_and_scale</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
183+
<span class="n">mask_and_scale</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
184184
<span class="n">decode_times</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
185185
<span class="n">concat_characters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
186186
<span class="n">decode_coords</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>

_modules/cfapyx/creator.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -646,10 +646,14 @@ <h1>Source code for cfapyx.creator</h1><div class="highlight"><pre>
646646
<span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">array_equal</span><span class="p">(</span><span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">],</span> <span class="n">ncattrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]):</span>
647647
<span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">concat_msg</span>
648648
<span class="k">continue</span>
649-
<span class="k">if</span> <span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">!=</span> <span class="n">ncattrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]:</span>
649+
<span class="k">try</span><span class="p">:</span>
650+
<span class="k">if</span> <span class="n">attrs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attr</span><span class="p">)</span> <span class="o">!=</span> <span class="n">ncattrs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">attr</span><span class="p">):</span>
651+
<span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">concat_msg</span>
652+
<span class="k">else</span><span class="p">:</span>
653+
<span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="n">ncattrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span>
654+
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
655+
<span class="c1"># Typically numpy array comparisons fail here.</span>
650656
<span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">concat_msg</span>
651-
<span class="k">else</span><span class="p">:</span>
652-
<span class="n">attrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span> <span class="o">=</span> <span class="n">ncattrs</span><span class="p">[</span><span class="n">attr</span><span class="p">]</span>
653657
<span class="k">return</span> <span class="n">attrs</span></div>
654658
</div>
655659

backend.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
<span id="xarray-backend-entrypoint-for-cfapyx"></span><h1>Xarray Backend Entrypoint for cfapyx<a class="headerlink" href="#module-cfapyx.backend" title="Link to this heading"></a></h1>
102102
<dl class="py function">
103103
<dt class="sig sig-object py" id="cfapyx.backend.open_cfa_dataset">
104-
<span class="sig-prename descclassname"><span class="pre">cfapyx.backend.</span></span><span class="sig-name descname"><span class="pre">open_cfa_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drop_variables</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask_and_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_times</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concat_characters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_coords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cftime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_timedelta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cfa_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/backend.html#open_cfa_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.backend.open_cfa_dataset" title="Link to this definition"></a></dt>
104+
<span class="sig-prename descclassname"><span class="pre">cfapyx.backend.</span></span><span class="sig-name descname"><span class="pre">open_cfa_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drop_variables</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask_and_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_times</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concat_characters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_coords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cftime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_timedelta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cfa_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/backend.html#open_cfa_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.backend.open_cfa_dataset" title="Link to this definition"></a></dt>
105105
<dd><p>Top-level function which opens a CFA dataset using Xarray.</p>
106106
<p>Creates a CFA Datastore
107107
from the <code class="docutils literal notranslate"><span class="pre">filename_or_obj</span></code> provided, then passes this to a CFA StoreBackendEntrypoint
@@ -133,7 +133,7 @@
133133
<dd><p>Open CFA-netCDF files (.nca) using ‘cfapyx’ in Xarray</p>
134134
<dl class="py method">
135135
<dt class="sig sig-object py" id="cfapyx.backend.CFANetCDFBackendEntrypoint.open_dataset">
136-
<span class="sig-name descname"><span class="pre">open_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drop_variables</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask_and_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_times</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concat_characters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_coords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cftime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_timedelta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cfa_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/backend.html#CFANetCDFBackendEntrypoint.open_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.backend.CFANetCDFBackendEntrypoint.open_dataset" title="Link to this definition"></a></dt>
136+
<span class="sig-name descname"><span class="pre">open_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_obj</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drop_variables</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask_and_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_times</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concat_characters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_coords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cftime</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode_timedelta</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cfa_options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/backend.html#CFANetCDFBackendEntrypoint.open_dataset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.backend.CFANetCDFBackendEntrypoint.open_dataset" title="Link to this definition"></a></dt>
137137
<dd><p>Returns a complete xarray representation of a CFA-netCDF dataset which includes expanding/decoding
138138
CFA aggregated variables into proper arrays.</p>
139139
</dd></dl>

datastore.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
<span id="cfa-datastore-in-xarray"></span><h1>CFA Datastore in Xarray<a class="headerlink" href="#module-cfapyx.datastore" title="Link to this heading"></a></h1>
103103
<dl class="py class">
104104
<dt class="sig sig-object py" id="cfapyx.datastore.CFADataStore">
105-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cfapyx.datastore.</span></span><span class="sig-name descname"><span class="pre">CFADataStore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock=CombinedLock([&lt;SerializableLock:</span> <span class="pre">3c696b8b-473e-4c75-beae-14ccd69828b8&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;SerializableLock:</span> <span class="pre">3b59d512-8d10-4309-b845-08388bb54dfa&gt;])</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoclose=False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/datastore.html#CFADataStore"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.datastore.CFADataStore" title="Link to this definition"></a></dt>
105+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cfapyx.datastore.</span></span><span class="sig-name descname"><span class="pre">CFADataStore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lock=CombinedLock([&lt;SerializableLock:</span> <span class="pre">73d481b3-f118-4698-9b4f-649be54baf6b&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">&lt;SerializableLock:</span> <span class="pre">6039f24a-ccb7-48e2-9336-02bfb6dd5c67&gt;])</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoclose=False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/cfapyx/datastore.html#CFADataStore"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#cfapyx.datastore.CFADataStore" title="Link to this definition"></a></dt>
106106
<dd><p>DataStore container for the CFA-netCDF loaded file. Contains all unpacking routines
107107
directly related to the specific variables and attributes. The <code class="docutils literal notranslate"><span class="pre">NetCDF4Datastore</span></code>
108108
Xarray class from which this class inherits, has an <code class="docutils literal notranslate"><span class="pre">__init__</span></code> method which

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)