Skip to content

Commit

Permalink
build based on aa3fbbe
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 7, 2023
0 parents commit bcbe9ae
Show file tree
Hide file tree
Showing 28 changed files with 2,245 additions and 0 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-12-05T21:53:18","documenter_version":"1.2.1"}}
13 changes: 13 additions & 0 deletions dev/api/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · CalibrateAtmos.jl</title><meta name="title" content="API · CalibrateAtmos.jl"/><meta property="og:title" content="API · CalibrateAtmos.jl"/><meta property="twitter:title" content="API · CalibrateAtmos.jl"/><meta name="description" content="Documentation for CalibrateAtmos.jl."/><meta property="og:description" content="Documentation for CalibrateAtmos.jl."/><meta property="twitter:description" content="Documentation for CalibrateAtmos.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/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="../">CalibrateAtmos.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><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../quickstart/">Getting Started</a></li><li><a class="tocitem" href="../experiment_setup_guide/">Experiment Setup Guide</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#ClimaAtmos-Interface"><span>ClimaAtmos Interface</span></a></li><li><a class="tocitem" href="#EnsembleKalmanProcesses-Interface"><span>EnsembleKalmanProcesses Interface</span></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>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/CliMA/CalibrateAtmos.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/CliMA/CalibrateAtmos.jl/blob/main/docs/src/api.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="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h2 id="ClimaAtmos-Interface"><a class="docs-heading-anchor" href="#ClimaAtmos-Interface">ClimaAtmos Interface</a><a id="ClimaAtmos-Interface-1"></a><a class="docs-heading-anchor-permalink" href="#ClimaAtmos-Interface" 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="CalibrateAtmos.get_atmos_config" href="#CalibrateAtmos.get_atmos_config"><code>CalibrateAtmos.get_atmos_config</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_atmos_config(member, iteration, experiment_id::AbstractString)
get_atmos_config(member, iteration, config_dict::AbstractDict)</code></pre><p>Returns an AtmosConfig object for the given member and iteration. If given an experiment id string, it will load the config from the corresponding YAML file. Turns off default diagnostics and sets the TOML parameter file to the member&#39;s path. This assumes that the config dictionary has <code>output_dir</code> and <code>restart_file</code> keys.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateAtmos.jl/blob/e5c14155714055d5cfdd9405d921918bc8778218/src/atmos_interface.jl#L10-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="CalibrateAtmos.run_forward_model" href="#CalibrateAtmos.run_forward_model"><code>CalibrateAtmos.run_forward_model</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">run_forward_model(atmos_config::CA.AtmosConfig)</code></pre><p>Runs the atmosphere model with the given an AtmosConfig object. Currently only has basic error handling.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateAtmos.jl/blob/e5c14155714055d5cfdd9405d921918bc8778218/src/atmos_interface.jl#L41-L46">source</a></section></article><h2 id="EnsembleKalmanProcesses-Interface"><a class="docs-heading-anchor" href="#EnsembleKalmanProcesses-Interface">EnsembleKalmanProcesses Interface</a><a id="EnsembleKalmanProcesses-Interface-1"></a><a class="docs-heading-anchor-permalink" href="#EnsembleKalmanProcesses-Interface" 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="CalibrateAtmos.initialize" href="#CalibrateAtmos.initialize"><code>CalibrateAtmos.initialize</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">initialize(
experiment_id;
config = YAML.load_file(&quot;experiments/$experiment_id/ekp_config.yml&quot;),
Γ = JLD2.load(config[&quot;truth_noise&quot;]),
y = JLD2.load(config[&quot;truth_data&quot;]),
rng_seed = 1234,
)</code></pre><p>Initializes the EKP object and the model ensemble.</p><p>Takes in</p><ul><li><code>experiment_id</code>: the name of the experiment, which corresponds to the name of the subfolder in <code>experiments/</code></li><li><code>config</code>: a dictionary of configuration values</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateAtmos.jl/blob/e5c14155714055d5cfdd9405d921918bc8778218/src/ekp_interface.jl#L16-L29">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="CalibrateAtmos.update_ensemble" href="#CalibrateAtmos.update_ensemble"><code>CalibrateAtmos.update_ensemble</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">update_ensemble(
experiment_id,
iteration;
config = YAML.load_file(&quot;experiments/$experiment_id/ekp_config.yml&quot;),
)</code></pre><p>Updates the EKI object and saves parameters for the next iteration. Assumes that the observation map has been run and saved in the current iteration folder.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateAtmos.jl/blob/e5c14155714055d5cfdd9405d921918bc8778218/src/ekp_interface.jl#L74-L82">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../experiment_setup_guide/">« Experiment Setup Guide</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 5 December 2023 21:53">Tuesday 5 December 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit bcbe9ae

Please sign in to comment.