build based on e7ad295

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-24T16:50:21","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-24T17:04:02","documenter_version":"1.7.0"}}

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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Thursday 24 October 2024 16:50">Thursday 24 October 2024</span>. Using Julia version 1.11.1.</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Thursday 24 October 2024 17:04">Thursday 24 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/dimensions/index.html

@@ -9,7 +9,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/857c394bc759dfacf482ce355720fd1ddc028cc3/src/dataset.jl#L331-L352">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CommonDataModel.defDim" href="#CommonDataModel.defDim"><code>CommonDataModel.defDim</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></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/e7ad295c65b9e8ab16fb16e3f1728db995988803/src/dataset.jl#L331-L352">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CommonDataModel.defDim" href="#CommonDataModel.defDim"><code>CommonDataModel.defDim</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></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
 ds = NCDataset(&quot;/tmp/test.nc&quot;,&quot;c&quot;)
 defDim(ds,&quot;lon&quot;,100)
 # [...]
@@ -24,8 +24,8 @@
 ds[&quot;unlimited_variable&quot;][:,:,1:4] = 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/857c394bc759dfacf482ce355720fd1ddc028cc3/src/dimensions.jl#L24-L59">source</a></section><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><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L46-L51">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CommonDataModel.unlimited-Tuple{CommonDataModel.Dimensions}" href="#CommonDataModel.unlimited-Tuple{CommonDataModel.Dimensions}"><code>CommonDataModel.unlimited</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unlimited(d::Dimensions)</code></pre><p>Return the names of all unlimited dimensions.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L124-L128">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.setindex!-Tuple{CommonDataModel.Dimensions, Any, AbstractString}" href="#Base.setindex!-Tuple{CommonDataModel.Dimensions, Any, AbstractString}"><code>Base.setindex!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">setindex!(d::Dimensions,len,name::AbstractString)</code></pre><p>Defines the dimension called <code>name</code> to the length <code>len</code>, for example:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;,&quot;c&quot;)
-ds.dim[&quot;longitude&quot;] = 100</code></pre><p>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></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L106-L118">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NCDatasets.renameDim-Tuple{NCDataset, Union{AbstractString, Symbol}, Union{AbstractString, Symbol}}" href="#NCDatasets.renameDim-Tuple{NCDataset, Union{AbstractString, Symbol}, Union{AbstractString, Symbol}}"><code>NCDatasets.renameDim</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">renameDim(ds::NCDataset,oldname::SymbolOrString,newname::SymbolOrString)</code></pre><p>Renames the dimenion <code>oldname</code> in the dataset <code>ds</code> with the name <code>newname</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/857c394bc759dfacf482ce355720fd1ddc028cc3/src/dimensions.jl#L67-L71">source</a></section></article><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/e7ad295c65b9e8ab16fb16e3f1728db995988803/src/dimensions.jl#L24-L59">source</a></section><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><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L46-L51">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CommonDataModel.unlimited-Tuple{CommonDataModel.Dimensions}" href="#CommonDataModel.unlimited-Tuple{CommonDataModel.Dimensions}"><code>CommonDataModel.unlimited</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">unlimited(d::Dimensions)</code></pre><p>Return the names of all unlimited dimensions.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L124-L128">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.setindex!-Tuple{CommonDataModel.Dimensions, Any, AbstractString}" href="#Base.setindex!-Tuple{CommonDataModel.Dimensions, Any, AbstractString}"><code>Base.setindex!</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">setindex!(d::Dimensions,len,name::AbstractString)</code></pre><p>Defines the dimension called <code>name</code> to the length <code>len</code>, for example:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;,&quot;c&quot;)
+ds.dim[&quot;longitude&quot;] = 100</code></pre><p>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></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeo/CommonDataModel.jl/blob/v0.3.6/src/dimension.jl#L106-L118">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NCDatasets.renameDim-Tuple{NCDataset, Union{AbstractString, Symbol}, Union{AbstractString, Symbol}}" href="#NCDatasets.renameDim-Tuple{NCDataset, Union{AbstractString, Symbol}, Union{AbstractString, Symbol}}"><code>NCDatasets.renameDim</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">renameDim(ds::NCDataset,oldname::SymbolOrString,newname::SymbolOrString)</code></pre><p>Renames the dimenion <code>oldname</code> in the dataset <code>ds</code> with the name <code>newname</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/e7ad295c65b9e8ab16fb16e3f1728db995988803/src/dimensions.jl#L67-L71">source</a></section></article><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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Thursday 24 October 2024 16:50">Thursday 24 October 2024</span>. Using Julia version 1.11.1.</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Thursday 24 October 2024 17:04">Thursday 24 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>