build based on 3c0b037

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-10T00:55:52","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-10T00:56:14","documenter_version":"1.7.0"}}

dev/index.html

@@ -97,4 +97,4 @@
  ⋮
  1.5629494562745093e-6
  1.5608462169766426e-6
- 1.544798031449318e-6</code></pre><h2 id="Reference-(function-docstrings)"><a class="docs-heading-anchor" href="#Reference-(function-docstrings)">Reference (function docstrings)</a><a id="Reference-(function-docstrings)-1"></a><a class="docs-heading-anchor-permalink" href="#Reference-(function-docstrings)" title="Permalink"></a></h2><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="WorldOceanAtlasTools.convert_to_Unitful-Tuple{String}" href="#WorldOceanAtlasTools.convert_to_Unitful-Tuple{String}"><code>WorldOceanAtlasTools.convert_to_Unitful</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">convert_WOAunits_to_unitful(s)</code></pre><p>Converts the string from WOA&#39;s <code>units</code> attribute to a Unitful.jl unit.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/convert_to_Unitful.jl#L1-L5">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="WorldOceanAtlasTools.fit_to_grid-Tuple{OceanGrids.OceanGrid, Any}" href="#WorldOceanAtlasTools.fit_to_grid-Tuple{OceanGrids.OceanGrid, Any}"><code>WorldOceanAtlasTools.fit_to_grid</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">fit_to_grid(grid, tracer; product_year=2018, period=0, resolution=1, field=&quot;an&quot;)</code></pre><p>Returns <code>χ_3D</code>, <code>σ²_3D</code> of &quot;regridded&quot; WOA data using a nearest neighbor approach.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/functions.jl#L146-L150">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="WorldOceanAtlasTools.get_3D_field-Tuple{Any}" href="#WorldOceanAtlasTools.get_3D_field-Tuple{Any}"><code>WorldOceanAtlasTools.get_3D_field</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">get_3D_field(tracer; product_year=2018, period=0, resolution=1, field=&quot;an&quot;)</code></pre><p>Downloads and returns the 3D field of a tracer from the World Ocean Atlas.</p><p>Tracers are either &quot;phosphate&quot;, &quot;nitrate&quot;, or &quot;silicate&quot;. Availabe product years are 2009, 2013, and 2018 (default: 2018). Resolution is either &quot;5°&quot;, &quot;1°&quot;, or &quot;0.25°&quot; (default: 1°). Fields are &quot;mean&quot; or &quot;an&quot; (for objectively analyzed climatology). (default = &quot;an&quot;.)</p><p>Note that WOA&#39;s nomenclature should work too, e.g., &quot;p&quot; for &quot;phosphate&quot;, &quot;mn&quot; for &quot;mean&quot;, and so on.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/functions.jl#L2-L15">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="WorldOceanAtlasTools.mean_std_and_number_obs-Tuple{Any, Any}" href="#WorldOceanAtlasTools.mean_std_and_number_obs-Tuple{Any, Any}"><code>WorldOceanAtlasTools.mean_std_and_number_obs</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">mean_std_and_number_obs(ds, tracer)</code></pre><p>Returns a DataFrame containing the following columns lat, lon, depth, mean, std, nobs</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/functions.jl#L47-L52">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="WorldOceanAtlasTools.observations-Tuple{String}" href="#WorldOceanAtlasTools.observations-Tuple{String}"><code>WorldOceanAtlasTools.observations</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">observations(tracer::String; metadatakeys=(&quot;lat&quot;, &quot;lon&quot;, &quot;depth&quot;))</code></pre><p>Returns observations of <code>tracer</code> with its metadata.</p><p><strong>Example</strong></p><pre><code class="nohighlight hljs">obs = observations(&quot;po4&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/functions.jl#L183-L193">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="WorldOceanAtlasTools.register_WOA-Tuple{Any}" href="#WorldOceanAtlasTools.register_WOA-Tuple{Any}"><code>WorldOceanAtlasTools.register_WOA</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">register_WOA(tracer; product_year=2018, period=0, resolution=1)</code></pre><p>Registers a <code>datadep</code> for the variable <code>tracer</code> averaged over <code>period</code> at resolution <code>resolution</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/names.jl#L14-L18">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="WorldOceanAtlasTools.url_WOA-Tuple{Any}" href="#WorldOceanAtlasTools.url_WOA-Tuple{Any}"><code>WorldOceanAtlasTools.url_WOA</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">url_WOA(tracer; product_year=2018, period=0, resolution=1)</code></pre><p>Returns the URL (<code>String</code>) for the NetCDF file of the World Ocean Atlas. This URL <code>String</code> typically looks like     <code>&quot;https://data.nodc.noaa.gov/woa/WOA13/DATAv2/phosphate/netcdf/all/1.00/woa13_all_p00_01.nc&quot;</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/names.jl#L258-L266">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="WorldOceanAtlasTools.varname-Tuple{String}" href="#WorldOceanAtlasTools.varname-Tuple{String}"><code>WorldOceanAtlasTools.varname</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">varname(tracer)</code></pre><p>Returns the World Ocean Data variable name that &quot;matches&quot; <code>tracer</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/9361f7c517aebc25fe4b9a4e7132d1007de3f38e/src/names.jl#L301-L305">source</a></section></article></article><nav class="docs-footer"><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="Tuesday 10 September 2024 00:55">Tuesday 10 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 1.544798031449318e-6</code></pre><h2 id="Reference-(function-docstrings)"><a class="docs-heading-anchor" href="#Reference-(function-docstrings)">Reference (function docstrings)</a><a id="Reference-(function-docstrings)-1"></a><a class="docs-heading-anchor-permalink" href="#Reference-(function-docstrings)" title="Permalink"></a></h2><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="WorldOceanAtlasTools.convert_to_Unitful-Tuple{String}" href="#WorldOceanAtlasTools.convert_to_Unitful-Tuple{String}"><code>WorldOceanAtlasTools.convert_to_Unitful</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">convert_WOAunits_to_unitful(s)</code></pre><p>Converts the string from WOA&#39;s <code>units</code> attribute to a Unitful.jl unit.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/convert_to_Unitful.jl#L1-L5">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="WorldOceanAtlasTools.fit_to_grid-Tuple{OceanGrids.OceanGrid, Any}" href="#WorldOceanAtlasTools.fit_to_grid-Tuple{OceanGrids.OceanGrid, Any}"><code>WorldOceanAtlasTools.fit_to_grid</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">fit_to_grid(grid, tracer; product_year=2018, period=0, resolution=1, field=&quot;an&quot;)</code></pre><p>Returns <code>χ_3D</code>, <code>σ²_3D</code> of &quot;regridded&quot; WOA data using a nearest neighbor approach.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/functions.jl#L146-L150">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="WorldOceanAtlasTools.get_3D_field-Tuple{Any}" href="#WorldOceanAtlasTools.get_3D_field-Tuple{Any}"><code>WorldOceanAtlasTools.get_3D_field</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">get_3D_field(tracer; product_year=2018, period=0, resolution=1, field=&quot;an&quot;)</code></pre><p>Downloads and returns the 3D field of a tracer from the World Ocean Atlas.</p><p>Tracers are either &quot;phosphate&quot;, &quot;nitrate&quot;, or &quot;silicate&quot;. Availabe product years are 2009, 2013, and 2018 (default: 2018). Resolution is either &quot;5°&quot;, &quot;1°&quot;, or &quot;0.25°&quot; (default: 1°). Fields are &quot;mean&quot; or &quot;an&quot; (for objectively analyzed climatology). (default = &quot;an&quot;.)</p><p>Note that WOA&#39;s nomenclature should work too, e.g., &quot;p&quot; for &quot;phosphate&quot;, &quot;mn&quot; for &quot;mean&quot;, and so on.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/functions.jl#L2-L15">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="WorldOceanAtlasTools.mean_std_and_number_obs-Tuple{Any, Any}" href="#WorldOceanAtlasTools.mean_std_and_number_obs-Tuple{Any, Any}"><code>WorldOceanAtlasTools.mean_std_and_number_obs</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">mean_std_and_number_obs(ds, tracer)</code></pre><p>Returns a DataFrame containing the following columns lat, lon, depth, mean, std, nobs</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/functions.jl#L47-L52">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="WorldOceanAtlasTools.observations-Tuple{String}" href="#WorldOceanAtlasTools.observations-Tuple{String}"><code>WorldOceanAtlasTools.observations</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">observations(tracer::String; metadatakeys=(&quot;lat&quot;, &quot;lon&quot;, &quot;depth&quot;))</code></pre><p>Returns observations of <code>tracer</code> with its metadata.</p><p><strong>Example</strong></p><pre><code class="nohighlight hljs">obs = observations(&quot;po4&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/functions.jl#L183-L193">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="WorldOceanAtlasTools.register_WOA-Tuple{Any}" href="#WorldOceanAtlasTools.register_WOA-Tuple{Any}"><code>WorldOceanAtlasTools.register_WOA</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">register_WOA(tracer; product_year=2018, period=0, resolution=1)</code></pre><p>Registers a <code>datadep</code> for the variable <code>tracer</code> averaged over <code>period</code> at resolution <code>resolution</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/names.jl#L14-L18">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="WorldOceanAtlasTools.url_WOA-Tuple{Any}" href="#WorldOceanAtlasTools.url_WOA-Tuple{Any}"><code>WorldOceanAtlasTools.url_WOA</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">url_WOA(tracer; product_year=2018, period=0, resolution=1)</code></pre><p>Returns the URL (<code>String</code>) for the NetCDF file of the World Ocean Atlas. This URL <code>String</code> typically looks like     <code>&quot;https://data.nodc.noaa.gov/woa/WOA13/DATAv2/phosphate/netcdf/all/1.00/woa13_all_p00_01.nc&quot;</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/names.jl#L258-L266">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="WorldOceanAtlasTools.varname-Tuple{String}" href="#WorldOceanAtlasTools.varname-Tuple{String}"><code>WorldOceanAtlasTools.varname</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">varname(tracer)</code></pre><p>Returns the World Ocean Data variable name that &quot;matches&quot; <code>tracer</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/briochemc/WorldOceanAtlasTools.jl/blob/3c0b037466207f14e0e7bcb7e7768df317a0120f/src/names.jl#L301-L305">source</a></section></article></article><nav class="docs-footer"><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="Tuesday 10 September 2024 00:56">Tuesday 10 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>