Skip to content

Commit

Permalink
build based on 6e42a28
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 30, 2024
1 parent 2731507 commit 30be022
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 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.10.5","generation_timestamp":"2024-09-27T18:35:06","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-30T06:37:54","documenter_version":"1.7.0"}}
4 changes: 2 additions & 2 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
m_u = 1.6605390666e-27 [kg] # Atomic mass constant
avog = 6.02214076e23 [mol^-1] # Avogadro constant
E_α = 3.518e6 [eV] # Alpha particle energy
E_n = 14.072e6 [eV] # Neutron energy</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/cda91a9dab870da8fd004b72dfd97290ce70df4d/src/constants.jl#L3-L19">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="IMAS.extract" href="#IMAS.extract"><code>IMAS.extract</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">extract(dd::IMAS.dd, library::Symbol=:extract)</code></pre><p>Libraries:</p><ul><li><code>:extract =&gt; ExtractFunctionsLibrary</code></li><li><code>:moopt =&gt; ConstraintFunctionsLibrary + ObjectiveFunctionsLibrary</code></li><li><code>:all =&gt; ExtractFunctionsLibrary + ConstraintFunctionsLibrary + ObjectiveFunctionsLibrary</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/cda91a9dab870da8fd004b72dfd97290ce70df4d/src/extract.jl#L162-L170">source</a></section><section><div><pre><code class="language-julia hljs">extract(dd::IMAS.dd, xtract::AbstractDict{Symbol,&lt;:ExtractFunction})</code></pre><p>Extract data from <code>dd</code>. Each of the <code>ExtractFunction</code> should accept <code>dd</code> as input, like this:</p><pre><code class="nohighlight hljs">xtract = IMAS.ExtractFunction[
E_n = 14.072e6 [eV] # Neutron energy</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/6e42a28cd69910339c5bc2aac71eca1d2557f43c/src/constants.jl#L3-L19">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="IMAS.extract" href="#IMAS.extract"><code>IMAS.extract</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">extract(dd::IMAS.dd, library::Symbol=:extract)</code></pre><p>Libraries:</p><ul><li><code>:extract =&gt; ExtractFunctionsLibrary</code></li><li><code>:moopt =&gt; ConstraintFunctionsLibrary + ObjectiveFunctionsLibrary</code></li><li><code>:all =&gt; ExtractFunctionsLibrary + ConstraintFunctionsLibrary + ObjectiveFunctionsLibrary</code></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/6e42a28cd69910339c5bc2aac71eca1d2557f43c/src/extract.jl#L163-L171">source</a></section><section><div><pre><code class="language-julia hljs">extract(dd::IMAS.dd, xtract::AbstractDict{Symbol,&lt;:ExtractFunction})</code></pre><p>Extract data from <code>dd</code>. Each of the <code>ExtractFunction</code> should accept <code>dd</code> as input, like this:</p><pre><code class="nohighlight hljs">xtract = IMAS.ExtractFunction[
:κ =&gt; ExtractFunction(:equilibrium, :κ, &quot;-&quot;, dd -&gt; dd.equilibrium.time_slice[].boundary.elongation)
:Te0 =&gt; ExtractFunction(:profiles, :Te0, &quot;keV&quot;, dd -&gt; dd.core_profiles.profiles_1d[].electrons.temperature[1] / 1E3)
]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/cda91a9dab870da8fd004b72dfd97290ce70df4d/src/extract.jl#L193-L202">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="IMAS.force_float" href="#IMAS.force_float"><code>IMAS.force_float</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">force_float(x::Measurement)</code></pre><p>Returns Float64</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/cda91a9dab870da8fd004b72dfd97290ce70df4d/src/real.jl#L31-L35">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="Measurements.:±" href="#Measurements.:±"><code>Measurements.:±</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value ± uncertainty</code></pre><p>Equivalent to Measurement.measurement(value, uncertainty)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/cda91a9dab870da8fd004b72dfd97290ce70df4d/src/real.jl#L43-L47">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« IMAS.jl</a><a class="docs-footer-nextpage" href="../license/">License »</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.7.0 on <span class="colophon-date" title="Friday 27 September 2024 18:35">Friday 27 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/6e42a28cd69910339c5bc2aac71eca1d2557f43c/src/extract.jl#L194-L203">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="IMAS.force_float" href="#IMAS.force_float"><code>IMAS.force_float</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">force_float(x::Measurement)</code></pre><p>Returns Float64</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/6e42a28cd69910339c5bc2aac71eca1d2557f43c/src/real.jl#L31-L35">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="Measurements.:±" href="#Measurements.:±"><code>Measurements.:±</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">value ± uncertainty</code></pre><p>Equivalent to Measurement.measurement(value, uncertainty)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/IMAS.jl/blob/6e42a28cd69910339c5bc2aac71eca1d2557f43c/src/real.jl#L43-L47">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« IMAS.jl</a><a class="docs-footer-nextpage" href="../license/">License »</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.7.0 on <span class="colophon-date" title="Monday 30 September 2024 06:37">Monday 30 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 30be022

Please sign in to comment.