Skip to content

Commit

Permalink
build based on 6d2313d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 27, 2024
1 parent 19c6904 commit f973dc4
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-27T20:17:46","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-27T23:49:13","documenter_version":"1.8.0"}}
60 changes: 30 additions & 30 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/howdoi/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
"lon" => [0.0, 1.0]
&quot;latitude&quot; =&gt; [0.0, 1.0, 2.0]</code></pre><h2 id="How-do-I-apply-a-land-or-sea-mask-to-a-OutputVar?"><a class="docs-heading-anchor" href="#How-do-I-apply-a-land-or-sea-mask-to-a-OutputVar?">How do I apply a land or sea mask to a <code>OutputVar</code>?</a><a id="How-do-I-apply-a-land-or-sea-mask-to-a-OutputVar?-1"></a><a class="docs-heading-anchor-permalink" href="#How-do-I-apply-a-land-or-sea-mask-to-a-OutputVar?" title="Permalink"></a></h2><p>You can use <code>apply_landmask</code> or <code>apply_oceanmask</code> to mask out the land or ocean, respectively, in a <code>OutputVar</code>. The result of <code>apply_landmask(var)</code> is data of <code>var</code>, where any coordinate corresponding to land is zero. Similarly, the result of <code>apply_oceanmask(var)</code> is data of <code>var</code>, where any coordinate corresponding to ocean is zero.</p><pre><code class="language-julia hljs">var_no_land = ClimaAnalysis.apply_landmask(var)
var_no_ocean = ClimaAnalysis.apply_oceanmask(var)</code></pre><h2 id="How-do-I-replace-NaN-and-missing-values-in-the-data-of-a-OutputVar-with-0.0?"><a class="docs-heading-anchor" href="#How-do-I-replace-NaN-and-missing-values-in-the-data-of-a-OutputVar-with-0.0?">How do I replace <code>NaN</code> and <code>missing</code> values in the data of a <code>OutputVar</code> with 0.0?</a><a id="How-do-I-replace-NaN-and-missing-values-in-the-data-of-a-OutputVar-with-0.0?-1"></a><a class="docs-heading-anchor-permalink" href="#How-do-I-replace-NaN-and-missing-values-in-the-data-of-a-OutputVar-with-0.0?" title="Permalink"></a></h2><p>You can use <code>replace</code> to replace all <code>NaN</code> and <code>missing</code> values in the data of a <code>OutputVar</code> with 0.0. See the example below of this usage.</p><pre><code class="language-julia hljs">var_no_nan_and_missing = ClimaAnalysis.replace(var, missing =&gt; 0.0, NaN =&gt; 0.0)</code></pre><h2 id="How-do-I-reverse-a-dimension-so-that-an-interpolant-can-be-made?"><a class="docs-heading-anchor" href="#How-do-I-reverse-a-dimension-so-that-an-interpolant-can-be-made?">How do I reverse a dimension so that an interpolant can be made?</a><a id="How-do-I-reverse-a-dimension-so-that-an-interpolant-can-be-made?-1"></a><a class="docs-heading-anchor-permalink" href="#How-do-I-reverse-a-dimension-so-that-an-interpolant-can-be-made?" title="Permalink"></a></h2><p>You can use <code>reverse_dim</code> to reverse a dimension by name. See the example below of this usage.</p><pre><code class="language-julia hljs"># Reversing pressure levels so that an interpolant can be made
var_reversed = reverse_dim(var, &quot;pressure_level&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« APIs</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 20:17">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
var_reversed = reverse_dim(var, &quot;pressure_level&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« APIs</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 23:49">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@
:cb =&gt; ca_kwargs(label = &quot;My label&quot;),
:axis =&gt; ca_kwargs(subtitle = &quot;My subtitle&quot;),
),
)</code></pre><p>When you pass a <code>GridLayout</code>, the optional argument <code>p_loc</code> refers to the placement within the layout. When you pass a <code>Figure</code>, it refers to the placement within the figure.</p><p>If you have <code>GeoMakie</code> and are working on a variable defined on a <code>long-lat</code> grid, you can directly plot on a projected global surface. For that, load <code>GeoMakie</code> and use the <code>heatmap2D_on_globe!</code> function.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="var/">OutputVars »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 20:17">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
)</code></pre><p>When you pass a <code>GridLayout</code>, the optional argument <code>p_loc</code> refers to the placement within the layout. When you pass a <code>Figure</code>, it refers to the placement within the figure.</p><p>If you have <code>GeoMakie</code> and are working on a variable defined on a <code>long-lat</code> grid, you can directly plot on a projected global surface. For that, load <code>GeoMakie</code> and use the <code>heatmap2D_on_globe!</code> function.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="var/">OutputVars »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 23:49">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/rmse_var/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@
11.3275
14.617
11.7075
9.955</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../visualize/">« Visualizing OutputVars</a><a class="docs-footer-nextpage" href="../visualize_rmse_var/">Visualizing RMSEVariables »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 20:17">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
9.955</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../visualize/">« Visualizing OutputVars</a><a class="docs-footer-nextpage" href="../visualize_rmse_var/">Visualizing RMSEVariables »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 23:49">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/var/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,4 @@

# Compute squared error and global MSE with custom masking function
ClimaAnalysis.squared_error(sim_var, obs_var, mask = mask_fn)
ClimaAnalysis.global_mse(sim_var, obs_var, mask = mask_fn)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../visualize/">Visualizing OutputVars »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 20:17">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
ClimaAnalysis.global_mse(sim_var, obs_var, mask = mask_fn)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../visualize/">Visualizing OutputVars »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 23:49">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/visualize/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@

fig = CairoMakie.Figure()
plot_bias_on_globe!(fig, var, mask = mask_fn)
CairoMakie.save(&quot;myfigure.pdf&quot;, fig)</code></pre><p>The output produces something like:</p><p><img src="../assets/plot_bias_with_custom_mask.png" alt="bias_with_custom_mask_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../var/">« OutputVars</a><a class="docs-footer-nextpage" href="../rmse_var/">RMSEVariables »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 20:17">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
CairoMakie.save(&quot;myfigure.pdf&quot;, fig)</code></pre><p>The output produces something like:</p><p><img src="../assets/plot_bias_with_custom_mask.png" alt="bias_with_custom_mask_plot"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../var/">« OutputVars</a><a class="docs-footer-nextpage" href="../rmse_var/">RMSEVariables »</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.8.0 on <span class="colophon-date" title="Wednesday 27 November 2024 23:49">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit f973dc4

Please sign in to comment.