Skip to content

Commit

Permalink
build based on 20c0bc7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 10, 2025
1 parent 0eb5298 commit df32eec
Show file tree
Hide file tree
Showing 11 changed files with 192 additions and 27 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-10T17:22:17","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-10T17:40:37","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · RainMaker.jl</title><meta name="title" content="Home · RainMaker.jl"/><meta property="og:title" content="Home · RainMaker.jl"/><meta property="twitter:title" content="Home · RainMaker.jl"/><meta name="description" content="Documentation for RainMaker.jl."/><meta property="og:description" content="Documentation for RainMaker.jl."/><meta property="twitter:description" content="Documentation for RainMaker.jl."/><meta property="og:url" content="https://speedyweather.github.io/RainMaker.jl/"/><meta property="twitter:url" content="https://speedyweather.github.io/RainMaker.jl/"/><link rel="canonical" href="https://speedyweather.github.io/RainMaker.jl/"/><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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"><div class="docs-package-name"><span class="docs-autofit"><a href>RainMaker.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="new_to_julia/">New to Julia?</a></li><li><a class="tocitem" href="rain_gauge/">RainGauge</a></li><li><span class="tocitem">RainMaker challenge</span><ul><li><a class="tocitem" href="instructions/">Instructions</a></li><li><a class="tocitem" href="submit/">Submit</a></li><li><a class="tocitem" href="leaderboard/">Leaderboard</a></li><li><a class="tocitem" href="submissions/">List of submissions</a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/SpeedyWeather/RainMaker.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/SpeedyWeather/RainMaker.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="RainMaker"><a class="docs-heading-anchor" href="#RainMaker">RainMaker</a><a id="RainMaker-1"></a><a class="docs-heading-anchor-permalink" href="#RainMaker" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/SpeedyWeather/RainMaker.jl">RainMaker</a>, a repository to measure precipitation inside a <a href="https://github.com/SpeedyWeather/SpeedyWeather.jl">SpeedyWeather.jl</a> simulation.</p><p>Contents</p><ul><li><a href="#Installation">Installation</a></li><li><a href="new_to_julia/#New-to-Julia?">New to Julia?</a></li><li><a href="rain_gauge/#RainGauge">RainGauge</a></li><li><a href="instructions/#RainMaker-instructions">RainMaker instructions</a></li><li><a href="submit/#Submit-to-the-RainMaker-challenge">Submit to the RainMaker challenge</a></li><li><a href="leaderboard/#RainMaker-leaderboard">RainMaker leaderboard</a></li><li><a href="submissions/#List-of-submissions">List of submissions</a></li></ul><p>Older versions of the documentation correspond to previous challenges used for teaching, may have different rules, but can be looked up as an archive of submissions to the RainMaker challenge.</p><ul><li><a href="https://speedyweather.github.io/RainMaker.jl/v0.1.1/leaderboard/"><strong>RainMaker.jl v0.1.1</strong>: Intelligent Earth CDT, Oxford, November 2024</a></li></ul><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p><a href="https://github.com/SpeedyWeather/RainMaker.jl">RainMaker.jl</a> is an official Julia package, so to install the latest version you can simply type</p><pre><code class="language-julia hljs">julia&gt; ] add RainMaker</code></pre><p>Where <code>]</code> opens Julia&#39;s package manager <a href="https://pkgdocs.julialang.org/v1/">Pkg.jl</a> which changes the prompt to <code>(@v1.11) pkg&gt;</code>, exit the package manager with backspace. Pkg.jl is also a package itself, so you can alternatively do</p><pre><code class="language-julia hljs">using Pkg
Pkg.add(&quot;RainMaker&quot;)</code></pre><p>RainMaker.jl depends on (among others)</p><ul><li><a href="https://github.com/SpeedyWeather/SpeedyWeather.jl">SpeedyWeather.jl</a></li><li><a href="https://github.com/MakieOrg/Makie.jl">Makie.jl</a> and its backend <a href="https://docs.makie.org/stable/explanations/backends/cairomakie">CairoMakie</a> for plotting</li></ul><p>While they are automatically installed, you will also want to install SpeedyWeather explicitly via</p><pre><code class="language-julia hljs">julia&gt; ] add SpeedyWeather</code></pre><p>or, again, <code>using Pkg; Pkg.add(&quot;SpeedyWeather&quot;)</code>. So that </p><pre><code class="language-julia hljs">using SpeedyWeather</code></pre><p>also just works as dependencies are otherwise hidden for direct usage.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="new_to_julia/">New to Julia? »</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="Friday 10 January 2025 17:22">Friday 10 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Pkg.add(&quot;RainMaker&quot;)</code></pre><p>RainMaker.jl depends on (among others)</p><ul><li><a href="https://github.com/SpeedyWeather/SpeedyWeather.jl">SpeedyWeather.jl</a></li><li><a href="https://github.com/MakieOrg/Makie.jl">Makie.jl</a> and its backend <a href="https://docs.makie.org/stable/explanations/backends/cairomakie">CairoMakie</a> for plotting</li></ul><p>While they are automatically installed, you will also want to install SpeedyWeather explicitly via</p><pre><code class="language-julia hljs">julia&gt; ] add SpeedyWeather</code></pre><p>or, again, <code>using Pkg; Pkg.add(&quot;SpeedyWeather&quot;)</code>. So that </p><pre><code class="language-julia hljs">using SpeedyWeather</code></pre><p>also just works as dependencies are otherwise hidden for direct usage.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="new_to_julia/">New to Julia? »</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="Friday 10 January 2025 17:40">Friday 10 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/instructions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@
set!(simulation, sea_surface_temperature=(λ, φ) -&gt; (30 &lt; φ &lt; 60) &amp;&amp; (270 &lt; λ &lt; 360) ? 2 : 0, add=true)

sst = simulation.prognostic_variables.ocean.sea_surface_temperature
heatmap(sst, title=&quot;SST with +2K in North Atlantic&quot;)</code></pre><p><img src="../sst_2K.png" alt="SST +2K"/></p><p>and similar for the <code>land_surface_temperature</code> in which case you would need to set the land-sea mask to 1 though, otherwise, while the land surface temperature is defined, there is not any land!</p><h2 id="Change-the-initial-conditions"><a class="docs-heading-anchor" href="#Change-the-initial-conditions">Change the initial conditions</a><a id="Change-the-initial-conditions-1"></a><a class="docs-heading-anchor-permalink" href="#Change-the-initial-conditions" title="Permalink"></a></h2><p>Changing the initial conditions is somewhat more advanced but gives you way more options is therefore added here in case you want to be creative. But you can also use it to create an ensemble by simply adding some small random noise and check how quickly the trajectories diverge (butterfly effect) or check whether in any member it rains more or less. The prognostic variables are</p><ul><li>relative vorticity <code>vor</code> units of 1/s, typical values are 5 to 10e-5 for high and low pressure (which sign is which?) systems</li><li>divergence <code>div</code>, units of 1/s, similar scale</li><li>temperature <code>temp</code>, units of K</li><li>logarithm of surface pressure <code>pres</code> in units of Pascal, with typical values of 960-1040hPa before the logarithm</li><li>humidity <code>humid</code>, units of kg/kg, tropical surface values reach order of 10 g/kg.</li></ul><p>You can set them with</p><pre><code class="language-julia hljs">set!(simulation, humid=0)</code></pre><p>to start with a dry atmosphere for example (how long does it take to rain when you do that?). You can use the same <code>set!</code> options as before, so maybe you can figure out</p><ul><li>how to add a storm?</li><li>how to start in a heatwave?</li></ul><p>Some more information on setting the initial conditions can be found <a href="https://speedyweather.github.io/SpeedyWeather.jl/dev/initial_conditions/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../rain_gauge/">« RainGauge</a><a class="docs-footer-nextpage" href="../submit/">Submit »</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="Friday 10 January 2025 17:22">Friday 10 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
heatmap(sst, title=&quot;SST with +2K in North Atlantic&quot;)</code></pre><p><img src="../sst_2K.png" alt="SST +2K"/></p><p>and similar for the <code>land_surface_temperature</code> in which case you would need to set the land-sea mask to 1 though, otherwise, while the land surface temperature is defined, there is not any land!</p><h2 id="Change-the-initial-conditions"><a class="docs-heading-anchor" href="#Change-the-initial-conditions">Change the initial conditions</a><a id="Change-the-initial-conditions-1"></a><a class="docs-heading-anchor-permalink" href="#Change-the-initial-conditions" title="Permalink"></a></h2><p>Changing the initial conditions is somewhat more advanced but gives you way more options is therefore added here in case you want to be creative. But you can also use it to create an ensemble by simply adding some small random noise and check how quickly the trajectories diverge (butterfly effect) or check whether in any member it rains more or less. The prognostic variables are</p><ul><li>relative vorticity <code>vor</code> units of 1/s, typical values are 5 to 10e-5 for high and low pressure (which sign is which?) systems</li><li>divergence <code>div</code>, units of 1/s, similar scale</li><li>temperature <code>temp</code>, units of K</li><li>logarithm of surface pressure <code>pres</code> in units of Pascal, with typical values of 960-1040hPa before the logarithm</li><li>humidity <code>humid</code>, units of kg/kg, tropical surface values reach order of 10 g/kg.</li></ul><p>You can set them with</p><pre><code class="language-julia hljs">set!(simulation, humid=0)</code></pre><p>to start with a dry atmosphere for example (how long does it take to rain when you do that?). You can use the same <code>set!</code> options as before, so maybe you can figure out</p><ul><li>how to add a storm?</li><li>how to start in a heatwave?</li></ul><p>Some more information on setting the initial conditions can be found <a href="https://speedyweather.github.io/SpeedyWeather.jl/dev/initial_conditions/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../rain_gauge/">« RainGauge</a><a class="docs-footer-nextpage" href="../submit/">Submit »</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="Friday 10 January 2025 17:40">Friday 10 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit df32eec

Please sign in to comment.