Skip to content

Commit

Permalink
build based on 393ced4
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 2, 2024
0 parents commit dec5b63
Show file tree
Hide file tree
Showing 1,308 changed files with 1,027,057 additions and 0 deletions.
26 changes: 26 additions & 0 deletions dev/API/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · ClimaParams.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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">ClimaParams.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="../toml/">TOML file interface</a></li><li><a class="tocitem" href="../param_retrieval/">Parameter retrieval</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#Parameter-dictionaries"><span>Parameter dictionaries</span></a></li><li><a class="tocitem" href="#File-parsing-and-parameter-logging"><span>File parsing and parameter logging</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"><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-edit-link" href="https://github.com/CliMA/ClimaParams.jl/blob/main/docs/src/API.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="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="Parameter-dictionaries"><a class="docs-heading-anchor" href="#Parameter-dictionaries">Parameter dictionaries</a><a id="Parameter-dictionaries-1"></a><a class="docs-heading-anchor-permalink" href="#Parameter-dictionaries" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.AbstractTOMLDict" href="#ClimaParams.AbstractTOMLDict"><code>ClimaParams.AbstractTOMLDict</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">AbstractTOMLDict{FT &lt;: AbstractFloat}</code></pre><p>Abstract parameter dict. One subtype:</p><ul><li><a href="#ClimaParams.ParamDict"><code>ParamDict</code></a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L1-L6">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.ParamDict" href="#ClimaParams.ParamDict"><code>ClimaParams.ParamDict</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ParamDict(data::Dict, override_dict::Union{Nothing,Dict})</code></pre><p>Structure to hold information read-in from TOML file, as well as a parametrization type <code>FT</code>.</p><p>Uses the name to search</p><p><strong>Fields</strong></p><ul><li><p><code>data</code>: dictionary representing a default/merged parameter TOML file</p></li><li><p><code>override_dict</code>: either a nothing, or a dictionary representing an override parameter TOML file</p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L12-L23">source</a></section></article><h2 id="File-parsing-and-parameter-logging"><a class="docs-heading-anchor" href="#File-parsing-and-parameter-logging">File parsing and parameter logging</a><a id="File-parsing-and-parameter-logging-1"></a><a class="docs-heading-anchor-permalink" href="#File-parsing-and-parameter-logging" title="Permalink"></a></h2><h3 id="User-facing-functions:"><a class="docs-heading-anchor" href="#User-facing-functions:">User facing functions:</a><a id="User-facing-functions:-1"></a><a class="docs-heading-anchor-permalink" href="#User-facing-functions:" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.create_toml_dict" href="#ClimaParams.create_toml_dict"><code>ClimaParams.create_toml_dict</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">create_toml_dict(FT;
override_file,
default_file,
)</code></pre><p>Creates a <code>ParamDict{FT}</code> struct, by reading and merging upto two TOML files or Julia Dicts with override information taking precedence over default information.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L400-L409">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.get_parameter_values" href="#ClimaParams.get_parameter_values"><code>ClimaParams.get_parameter_values</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_parameter_values(
pd::AbstractTOMLDict,
names::Union{String,Vector{String}},
component::String
)

get_parameter_values(
pd::AbstractTOMLDict,
name_map::Union{Dict, Vector{Pair}, NTuple{N, Pair}, Vararg{Pair}},
component::String
)</code></pre><p>Given a toml dict and a list of parameter names, returns a NamedTuple of the parameters and their values. If a component is specified, the parameter is logged as being used in that component.</p><p>Instead of a list of parameter names, this can take an iterable mapping from parameter names to variable names in code. Then, this function retrieves all parameters from the long names and returns a NamedTuple where the keys are the variable names.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L130-L150">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.get_tagged_parameter_values" href="#ClimaParams.get_tagged_parameter_values"><code>ClimaParams.get_tagged_parameter_values</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_tagged_parameter_values(pd::AbstractTOMLDict, tag::AbstractString)
get_tagged_parameter_values(pd::AbstractTOMLDict, tags::Vector{AbstractString})</code></pre><p>Returns a list of name-value Pairs of the parameters with the given tag(s).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L466-L471">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.get_tagged_parameter_names" href="#ClimaParams.get_tagged_parameter_names"><code>ClimaParams.get_tagged_parameter_names</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_tagged_parameter_names(pd::AbstractTOMLDict, tag::AbstractString)
get_tagged_parameter_names(pd::AbstractTOMLDict, tags::Vector{AbstractString})</code></pre><p>Returns a list of the parameters with a given tag.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L432-L437">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.fuzzy_match" href="#ClimaParams.fuzzy_match"><code>ClimaParams.fuzzy_match</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">fuzzy_match(s1::AbstractString, s2::AbstractString)</code></pre><p>Takes two strings and checks them for equality. This strips punctuation [&#39; &#39;, &#39;_&#39;, &#39;*&#39;, &#39;.&#39;, &#39;,&#39;, &#39;-&#39;, &#39;(&#39;, &#39;)&#39;] and removes capitalization.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L455-L460">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.float_type" href="#ClimaParams.float_type"><code>ClimaParams.float_type</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">float_type(::AbstractTOMLDict)</code></pre><p>The float type from the parameter dict.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L31-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.log_parameter_information" href="#ClimaParams.log_parameter_information"><code>ClimaParams.log_parameter_information</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">log_parameter_information(
pd::AbstractTOMLDict,
filepath;
strict::Bool = false
)</code></pre><p>Writes the parameter log file at <code>filepath</code>; checks that override parameters are all used.</p><p>If <code>strict = true</code>, errors if override parameters are unused.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L350-L361">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.write_log_file" href="#ClimaParams.write_log_file"><code>ClimaParams.write_log_file</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">write_log_file(pd::AbstractTOMLDict, filepath)</code></pre><p>Writes a log file of all used parameters of <code>pd</code> at the <code>filepath</code>. This file can be used to rerun the experiment.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L331-L336">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.merge_toml_files" href="#ClimaParams.merge_toml_files"><code>ClimaParams.merge_toml_files</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">merge_toml_files(filepaths; override)</code></pre><p>Parses and merges all of the given TOML filepaths and returns them as a Dict. This allows a toml_dict to be constructed from multiple TOML files. By default, non-unique TOML entries are not allowed, but this can be changed by setting <code>override = true</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L256-L263">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="ClimaParams.create_parameter_struct" href="#ClimaParams.create_parameter_struct"><code>ClimaParams.create_parameter_struct</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">create_parameter_struct(
toml_dict,
param_struct_type,
name_map,
nested_structs = (;),
)</code></pre><p>Constructs the parameter struct from the TOML dictionary. If the parameter struct has nested parameter structs, they must be passed. Floating type is inherited from the TOML dictionary.</p><p>This is fairly rigid and makes a few assumptions:</p><ul><li>The parameter struct has a constructor that takes keyword arguments</li><li>The parameter struct&#39;s first type parameter is the floating point type</li><li>All nested parameter structs are given.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/CliMA/ClimaParams.jl/blob/996dc135932cb8e97dffb05f43af55347ccd9d44/src/file_parsing.jl#L225-L241">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../param_retrieval/">« Parameter retrieval</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 20 August 2024 17:49">Tuesday 20 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit dec5b63

Please sign in to comment.