Skip to content

Commit

Permalink
build based on d589989
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 27, 2023
1 parent 9cdd29a commit eb0007f
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 36 deletions.
6 changes: 3 additions & 3 deletions dev/attributes/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Attributes · NCDatasets.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="NCDatasets.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">NCDatasets.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Introduction</a></li><li><a class="tocitem" href="../dataset/">Datasets</a></li><li><a class="tocitem" href="../dimensions/">Dimensions</a></li><li><a class="tocitem" href="../variables/">Variables</a></li><li class="is-active"><a class="tocitem" href>Attributes</a><ul class="internal"><li><a class="tocitem" href="#Attributes"><span>Attributes</span></a></li><li><a class="tocitem" href="#Possible-type-promotion-in-Julia"><span>Possible type promotion in Julia</span></a></li></ul></li><li><a class="tocitem" href="../performance/">Performance tips</a></li><li><a class="tocitem" href="../issues/">Known issues</a></li><li><a class="tocitem" href="../experimental/">Experimental features</a></li><li><a class="tocitem" href="../tutorials/">Tutorials</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Attributes</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Attributes</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/master/docs/src/attributes.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h2 id="Attributes"><a class="docs-heading-anchor" href="#Attributes">Attributes</a><a id="Attributes-1"></a><a class="docs-heading-anchor-permalink" href="#Attributes" title="Permalink"></a></h2><p>The NetCDF dataset (as returned by <code>NCDataset</code> or NetCDF groups) and the NetCDF variables (as returned by <code>getindex</code>, <code>variable</code> or <code>defVar</code>) have the field <code>attrib</code> which has the type <code>NCDatasets.Attributes</code> and behaves like a julia dictionary.</p><article class="docstring"><header><a class="docstring-binding" id="Base.getindex-Tuple{NCDatasets.Attributes, AbstractString}" href="#Base.getindex-Tuple{NCDatasets.Attributes, AbstractString}"><code>Base.getindex</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">getindex(a::Attributes,name::SymbolOrString)</code></pre><p>Return the value of the attribute called <code>name</code> from the attribute list <code>a</code>. Generally the attributes are loaded by indexing, for example:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;)
title = ds.attrib[&quot;title&quot;]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/a0ca0274b4d42a644772c339ac151c2cf8ac53a5/src/attributes.jl#L29-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.setindex!-Tuple{NCDatasets.Attributes, Any, AbstractString}" href="#Base.setindex!-Tuple{NCDatasets.Attributes, Any, AbstractString}"><code>Base.setindex!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.setindex!(a::Attributes,data,name::SymbolOrString)</code></pre><p>Set the attribute called <code>name</code> to the value <code>data</code> in the attribute list <code>a</code>. <code>data</code> can be a vector or a scalar. A scalar is handeld as a vector with one element in the NetCDF data model.</p><p>Generally the attributes are defined by indexing, for example:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;,&quot;c&quot;)
title = ds.attrib[&quot;title&quot;]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/d58998962f243f3b1cde56384a036ca5710dd6a1/src/attributes.jl#L29-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.setindex!-Tuple{NCDatasets.Attributes, Any, AbstractString}" href="#Base.setindex!-Tuple{NCDatasets.Attributes, Any, AbstractString}"><code>Base.setindex!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.setindex!(a::Attributes,data,name::SymbolOrString)</code></pre><p>Set the attribute called <code>name</code> to the value <code>data</code> in the attribute list <code>a</code>. <code>data</code> can be a vector or a scalar. A scalar is handeld as a vector with one element in the NetCDF data model.</p><p>Generally the attributes are defined by indexing, for example:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;,&quot;c&quot;)
ds.attrib[&quot;title&quot;] = &quot;my title&quot;
close(ds)</code></pre><p>If <code>data</code> is a string, then attribute is saved as a list of NetCDF characters (<code>NC_CHAR</code>) with the appropriate length. To save the attribute as a string (<code>NC_STRING</code>) you can use the following:</p><pre><code class="language-julia hljs">ds = NCDataset(&quot;file.nc&quot;,&quot;c&quot;)
ds.attrib[&quot;title&quot;] = [&quot;my title&quot;]
close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/a0ca0274b4d42a644772c339ac151c2cf8ac53a5/src/attributes.jl#L46-L72">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.keys-Tuple{NCDatasets.Attributes}" href="#Base.keys-Tuple{NCDatasets.Attributes}"><code>Base.keys</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.keys(a::Attributes)</code></pre><p>Return a list of the names of all attributes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/a0ca0274b4d42a644772c339ac151c2cf8ac53a5/src/attributes.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.delete!-Tuple{NCDatasets.Attributes, AbstractString}" href="#Base.delete!-Tuple{NCDatasets.Attributes, AbstractString}"><code>Base.delete!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.delete!(a::Attributes, name)</code></pre><p>Delete the attribute <code>name</code> from the attribute list <code>a</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/a0ca0274b4d42a644772c339ac151c2cf8ac53a5/src/attributes.jl#L94-L98">source</a></section></article><p>Loading all attributes as a <code>Dict</code> can be achieved by passing <code>ds.attrib</code> (where <code>ds</code> is the <code>NCDataset</code>) as argument to <code>Dict</code>.</p><pre><code class="language-julia hljs">using NCDatasets
close(ds)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/d58998962f243f3b1cde56384a036ca5710dd6a1/src/attributes.jl#L46-L72">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.keys-Tuple{NCDatasets.Attributes}" href="#Base.keys-Tuple{NCDatasets.Attributes}"><code>Base.keys</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.keys(a::Attributes)</code></pre><p>Return a list of the names of all attributes.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/d58998962f243f3b1cde56384a036ca5710dd6a1/src/attributes.jl#L78-L82">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Base.delete!-Tuple{NCDatasets.Attributes, AbstractString}" href="#Base.delete!-Tuple{NCDatasets.Attributes, AbstractString}"><code>Base.delete!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Base.delete!(a::Attributes, name)</code></pre><p>Delete the attribute <code>name</code> from the attribute list <code>a</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Alexander-Barth/NCDatasets.jl/blob/d58998962f243f3b1cde56384a036ca5710dd6a1/src/attributes.jl#L94-L98">source</a></section></article><p>Loading all attributes as a <code>Dict</code> can be achieved by passing <code>ds.attrib</code> (where <code>ds</code> is the <code>NCDataset</code>) as argument to <code>Dict</code>.</p><pre><code class="language-julia hljs">using NCDatasets
ncfile = download(&quot;https://www.unidata.ucar.edu/software/netcdf/examples/sresa1b_ncar_ccsm3-example.nc&quot;);
ds = NCDataset(ncfile);
attributes_as_dictionary = Dict(ds.attrib)
Expand All @@ -29,4 +29,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 26 October 2023 20:11">Thursday 26 October 2023</span>. Using Julia version 1.9.3.</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="Friday 27 October 2023 09:30">Friday 27 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit eb0007f

Please sign in to comment.