Skip to content

Commit

Permalink
build based on 62f0315
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 30, 2024
0 parents commit 6eee26c
Show file tree
Hide file tree
Showing 813 changed files with 660,793 additions and 0 deletions.
38 changes: 38 additions & 0 deletions dev/API/Diagnostics/index.html

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions dev/API/DistributionUtils/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>DistributionUtils · CalibrateEDMF.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="CalibrateEDMF.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">CalibrateEDMF.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="../../">Home</a></li><li><a class="tocitem" href="../../installation/">Installation instructions</a></li><li><a class="tocitem" href="../../getting_started/">Getting started</a></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox" checked/><label class="tocitem" for="menuitem-4"><span class="docs-label">API</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../Diagnostics/">Diagnostics</a></li><li><a class="tocitem" href="../ReferenceModels/">ReferenceModels</a></li><li><a class="tocitem" href="../ReferenceStats/">ReferenceStats</a></li><li><a class="tocitem" href="../Pipeline/">Pipeline</a></li><li><a class="tocitem" href="../TurbulenceConvectionUtils/">TurbulenceConvectionUtils</a></li><li><a class="tocitem" href="../KalmanProcessUtils/">KalmanProcessUtils</a></li><li class="is-active"><a class="tocitem" href>DistributionUtils</a></li><li><a class="tocitem" href="../LESUtils/">LESUtils</a></li><li><a class="tocitem" href="../HelperFuncs/">HelperFuncs</a></li></ul></li><li><a class="tocitem" href="../../tc_runner/">Running TC.jl with optimal parameters</a></li><li><a class="tocitem" href="../../contributing/">Contributing</a></li><li><a class="tocitem" href="../../References/">References</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><a class="is-disabled">API</a></li><li class="is-active"><a href>DistributionUtils</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DistributionUtils</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/main/docs/src/API/DistributionUtils.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"><h1 id="DistributionUtils"><a class="docs-heading-anchor" href="#DistributionUtils">DistributionUtils</a><a id="DistributionUtils-1"></a><a class="docs-heading-anchor-permalink" href="#DistributionUtils" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.construct_priors" href="#CalibrateEDMF.DistributionUtils.construct_priors"><code>CalibrateEDMF.DistributionUtils.construct_priors</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">construct_priors(
const_dict::Dict{String, T};
unconstrained_σ::FT = 1.0,
prior_mean::Union{Dict{String, Vector{Float64}}, Nothing} = nothing,
outdir_path::String = pwd(),
to_file::Bool = true,
) where {T, FT}</code></pre><p>Define a prior Gaussian ParameterDistribution in unconstrained space from a dictionary of constraints.</p><p>This constructor assumes independent priors and the same unconstrained standard deviation for each parameter. Note that the standard deviation in unconstrained space is normalized with respect to the constrained interval width, so it automatically takes into account parameter scales.</p><p>The constructor also allows passing a prior mean for each parameter in constrained space.</p><p>Inputs:</p><ul><li>const_dict :: Dictionary of parameter names to constraints.</li><li>unconstrained_σ :: Standard deviation of the transformed gaussians (unconstrained space) or a dictionary mapping parameter names to standard deviations in unconstrained space.</li><li>prior_mean :: The mean value of the prior in constrained space. If not given, the prior is selected to be 0 in the centered unconstrained space.</li><li>outdir_path :: Output path.</li><li>to_file :: Whether to write the serialized prior to a JLD2 file.</li></ul><p>Output:</p><ul><li>The prior ParameterDistribution.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L83-L114">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.construct_prior" href="#CalibrateEDMF.DistributionUtils.construct_prior"><code>CalibrateEDMF.DistributionUtils.construct_prior</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">construct_prior(
param_name::String,
constraint::Vector{CT},
prior_μ::OptVec{FT},
unconstrained_σ,
) where {CT, FT &lt;: Real}</code></pre><p>Define a prior Gaussian ParameterDistribution in unconstrained space from a constraint, a prior in constrained space, and the standard deviation in unconstrained space.</p><p>The standard deviation in unconstrained space is normalized with respect to the constrained interval width, so it automatically takes into account parameter scales.</p><p>Inputs:</p><ul><li>param_name :: A parameter name.</li><li>constraint :: A 1-element vector containing the constraints.</li><li>prior_μ :: A 1-element vector containing the constrained prior mean.</li><li>unconstrained_σ :: Standard deviation of the transformed gaussians (unconstrained space).</li></ul><p>Output:</p><ul><li>The prior ParameterDistribution.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L156-L179">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.flatten_config_dict" href="#CalibrateEDMF.DistributionUtils.flatten_config_dict"><code>CalibrateEDMF.DistributionUtils.flatten_config_dict</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">flatten_config_dict(param_dict::Dict{String, Vector{T}})</code></pre><p>Given a dictionary of parameter names =&gt; parameter vectors of arbitrary length, return a pair of vectors (name, values) with vector components as unique parameters.</p><p>Inputs:</p><ul><li>param_dict :: Dictionary of parameter names to constraints.</li></ul><p>Outputs:</p><ul><li>u_names :: Vector{String} :: vector of parameter names</li><li>values :: Vector{Vector{T}} :: vector of single-valued vectors encapsulating parameter values.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L20-L33">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.flat_dict_keys_where" href="#CalibrateEDMF.DistributionUtils.flat_dict_keys_where"><code>CalibrateEDMF.DistributionUtils.flat_dict_keys_where</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">flat_dict_keys_where(dict::Dict{String, Vector{T}}, condition::Function = identity) where {T}</code></pre><p>Flattens the values of a dictionary with parameter vectors as keys, and returns the indices of entries in the flattened dictionary satisfying a given condition.</p><p>Inputs: param_dict :: Dictionary of parameter names to vectors. condition :: A condition function operating on each dictionary value. Outputs: Indices of flattened entries satisfying the <code>condition</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L59-L70">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.logmean_and_logstd" href="#CalibrateEDMF.DistributionUtils.logmean_and_logstd"><code>CalibrateEDMF.DistributionUtils.logmean_and_logstd</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">logmean_and_logstd(μ, σ)</code></pre><p>Returns the lognormal parameters μ and σ from the mean μ and std σ of the lognormal distribution.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L198-L203">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="CalibrateEDMF.DistributionUtils.mean_and_std_from_ln" href="#CalibrateEDMF.DistributionUtils.mean_and_std_from_ln"><code>CalibrateEDMF.DistributionUtils.mean_and_std_from_ln</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">mean_and_std_from_ln(μ, σ)</code></pre><p>Returns the mean and variance of the lognormal distribution from the lognormal parameters μ and σ.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/CalibrateEDMF.jl/blob/725cce629c8e54a29b1bf86a643c2703cdf48dc9/src/DistributionUtils.jl#L211-L216">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../KalmanProcessUtils/">« KalmanProcessUtils</a><a class="docs-footer-nextpage" href="../LESUtils/">LESUtils »</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="Tuesday 23 April 2024 03:08">Tuesday 23 April 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 6eee26c

Please sign in to comment.