build based on b52a71a

dev/attributes/index.html

@@ -28,4 +28,4 @@
 ))</code></pre><p>Note that <code>Dict</code> does not perserve the order of the attributes. Therefore an <code>OrderedDict</code> from the package <code>DataStructures</code> is preferable.</p><p>Or one could use simply the <code>fillvalue</code> parameter of <code>defVar</code>.</p><pre><code class="language-julia hljs">ncv1 = defVar(ds,&quot;v1&quot;, UInt8, (&quot;longitude&quot;, &quot;latitude&quot;, &quot;time&quot;), fillvalue = UInt8(255), attrib = [
     &quot;add_offset&quot;                =&gt; -1.0,
     &quot;scale_factor&quot;              =&gt; 5.0,
-])</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../variables/">« Variables</a><a class="docs-footer-nextpage" href="../performance/">Performance tips »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 7 December 2023 16:33">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+])</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../variables/">« Variables</a><a class="docs-footer-nextpage" href="../performance/">Performance tips »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 December 2023 10:21">Wednesday 13 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/dimensions/index.html

@@ -8,7 +8,7 @@
 
 if haskey(ds.dim,"lon")
     println("The file has a dimension 'lon'")
-end</code></pre><p>This example checks if the file <code>/tmp/test.nc</code> has a variable with the name <code>temperature</code> and a dimension with the name <code>lon</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/12823d73b3b78925c86e10b48ab8167e36211bdc/src/dataset.jl#L322-L343">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CommonDataModel.defDim" href="#CommonDataModel.defDim"><code>CommonDataModel.defDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">defDim(ds::NCDataset,name,len)</code></pre><p>Define a dimension in the data set <code>ds</code> with the given <code>name</code> and length <code>len</code>. If <code>len</code> is the special value <code>Inf</code>, then the dimension is considered as <code>unlimited</code>, i.e. it will grow as data is added to the NetCDF file.</p><p>For example:</p><pre><code class="language-julia hljs">using NCDatasets
+end</code></pre><p>This example checks if the file <code>/tmp/test.nc</code> has a variable with the name <code>temperature</code> and a dimension with the name <code>lon</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/b52a71af6a146175424cc47c5e147388399ef090/src/dataset.jl#L322-L343">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CommonDataModel.defDim" href="#CommonDataModel.defDim"><code>CommonDataModel.defDim</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">CommonDatamodel.defDim(ds::AbstractDataset,name::SymbolOrString,len)</code></pre><p>Create dimension with the name <code>name</code> in the data set <code>ds</code> with the length <code>len</code>. <code>len</code> can be <code>Inf</code> for unlimited dimensions.</p></div></section><section><div><pre><code class="nohighlight hljs">defDim(ds::NCDataset,name,len)</code></pre><p>Define a dimension in the data set <code>ds</code> with the given <code>name</code> and length <code>len</code>. If <code>len</code> is the special value <code>Inf</code>, then the dimension is considered as <code>unlimited</code>, i.e. it will grow as data is added to the NetCDF file.</p><p>For example:</p><pre><code class="language-julia hljs">using NCDatasets
 ds = NCDataset(&quot;/tmp/test.nc&quot;,&quot;c&quot;)
 defDim(ds,&quot;lon&quot;,100)
 # [...]
@@ -23,7 +23,7 @@
 ds[&quot;unlimited_variable&quot;][:,:,:] = randn(10,10,4)
 @show ds.dim[&quot;time&quot;]
 # returns now 4 as 4 time slice have been added
-close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/12823d73b3b78925c86e10b48ab8167e36211bdc/src/dimensions.jl#L24-L59">source</a></section><section><div><pre><code class="nohighlight hljs">CommonDatamodel.defDim(ds::AbstractDataset,name::SymbolOrString,len)</code></pre><p>Create dimension with the name <code>name</code> in the data set <code>ds</code> with the length <code>len</code>. <code>len</code> can be <code>Inf</code> for unlimited dimensions.</p></div></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>unlimited(d::NCDatasets.Dimensions)</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>setindex!(d::NCDatasets.Dimensions,len,name::AbstractString)</code>. Check Documenter&#39;s build log for details.</p></div></div><p>One can iterate over a list of dimensions as follows:</p><pre><code class="language-julia hljs">for (dimname,dim) in ds.dim
+close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/b52a71af6a146175424cc47c5e147388399ef090/src/dimensions.jl#L24-L59">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>unlimited(d::NCDatasets.Dimensions)</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>setindex!(d::NCDatasets.Dimensions,len,name::AbstractString)</code>. Check Documenter&#39;s build log for details.</p></div></div><p>One can iterate over a list of dimensions as follows:</p><pre><code class="language-julia hljs">for (dimname,dim) in ds.dim
     # all dimensions
     @show (dimname,dim)
-end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dataset/">« Datasets</a><a class="docs-footer-nextpage" href="../variables/">Variables »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 7 December 2023 16:33">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../dataset/">« Datasets</a><a class="docs-footer-nextpage" href="../variables/">Variables »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 December 2023 10:21">Wednesday 13 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/experimental/index.html

@@ -143,4 +143,4 @@
 
 @test v == v2
 close(ds)</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>For optimal performance, one should try to load contiguous data ranges, in particular when the data is loaded over HTTP/OPeNDAP.</p></div></div></div></section></article><h2 id="Experimental-functions"><a class="docs-heading-anchor" href="#Experimental-functions">Experimental functions</a><a id="Experimental-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Experimental-functions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="CommonDataModel.ancillaryvariables" href="#CommonDataModel.ancillaryvariables"><code>CommonDataModel.ancillaryvariables</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">ncvar = CommonDataModel.ancillaryvariables(ncv::CFVariable,modifier)</code></pre><p>Return the first ancillary variables from the NetCDF (or other format) variable <code>ncv</code> with the standard name modifier <code>modifier</code>. It can be used for example to access related variable like status flags.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.filter" href="#Base.filter"><code>Base.filter</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">data = CommonDataModel.filter(ncv, indices...; accepted_status_flags = nothing)</code></pre><p>Load and filter observations by replacing all variables without an acepted status flag to <code>missing</code>. It is used the attribute <code>ancillary_variables</code> to identify the status flag.</p><pre><code class="nohighlight hljs"># da[&quot;data&quot;] is 2D matrix
-good_data = NCDatasets.filter(ds[&quot;data&quot;],:,:, accepted_status_flags = [&quot;good_data&quot;,&quot;probably_good_data&quot;])</code></pre></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../issues/">« Known issues</a><a class="docs-footer-nextpage" href="../tutorials/">Tutorials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 7 December 2023 16:33">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+good_data = NCDatasets.filter(ds[&quot;data&quot;],:,:, accepted_status_flags = [&quot;good_data&quot;,&quot;probably_good_data&quot;])</code></pre></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../issues/">« Known issues</a><a class="docs-footer-nextpage" href="../tutorials/">Tutorials »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 December 2023 10:21">Wednesday 13 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -131,4 +131,4 @@
 # if the attribute does not exists
 
 units = get(v,"units","adimensional")
-close(ds)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="dataset/">Datasets »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Thursday 7 December 2023 16:33">Thursday 7 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+close(ds)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="dataset/">Datasets »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 December 2023 10:21">Wednesday 13 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>