Skip to content

Commit

Permalink
build based on df92f6c
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 20, 2024
1 parent 998db52 commit 54e927b
Show file tree
Hide file tree
Showing 15 changed files with 24 additions and 24 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.10.2","generation_timestamp":"2024-03-20T09:58:22","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-20T10:26:18","documenter_version":"1.3.0"}}
2 changes: 1 addition & 1 deletion dev/devLog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@
include the file in the code via a makro
material inclusion is very simple
bonds as elements in exodus -> filter small to large writing ?! -> elements can be x,y to be represented both
multiple materials in one block -&gt; evaluation order</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lib/references/">« References</a><a class="docs-footer-nextpage" href="../lib/faq/">FAQ »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 09:58">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
multiple materials in one block -&gt; evaluation order</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lib/references/">« References</a><a class="docs-footer-nextpage" href="../lib/faq/">FAQ »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 10:26">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/lib/faq/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/lib/functions/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/lib/io_functions/index.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions dev/lib/physics_functions/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/lib/references/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/man/basics/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
Status `~\v1.6\Project.toml`
[a93c6f00] PeriLab v1.0.0</code></pre><p>Throughout the rest of the tutorial we will assume that you have installed the PeriLab package and have already typed <code>using PeriLab</code> which loads the package:</p><pre><code class="language-julia hljs">using PeriLab</code></pre><p>If you want to make sure everything works as expected you can run the tests bundled with PeriLab, but be warned that it will take more than 30 minutes:</p><pre><code class="language-julia hljs">using Pkg

Pkg.test(&quot;PeriLab&quot;) # Warning! This will take more than 30 minutes.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Introduction</a><a class="docs-footer-nextpage" href="../getting_started/">Getting Started »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 09:58">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Pkg.test(&quot;PeriLab&quot;) # Warning! This will take more than 30 minutes.</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Introduction</a><a class="docs-footer-nextpage" href="../getting_started/">Getting Started »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 10:26">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/man/bond_filter/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/man/getting_started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
PeriLab.get_examples()
PeriLab.main(&quot;examples/DCB/DCBmodel.yaml&quot;)</code></pre><p>The main functionalities for the <code>yaml</code> input deck is given in</p><pre><code class="nohighlight hljs">&quot;examples/functionalities.yaml&quot;</code></pre><h2 id="Using-PeriLab-with-multiple-processors-(MPI)"><a class="docs-heading-anchor" href="#Using-PeriLab-with-multiple-processors-(MPI)">Using <code>PeriLab</code> with multiple processors (MPI)</a><a id="Using-PeriLab-with-multiple-processors-(MPI)-1"></a><a class="docs-heading-anchor-permalink" href="#Using-PeriLab-with-multiple-processors-(MPI)" title="Permalink"></a></h2><p>In order to run <code>PeriLab</code> for large scale problems <a href="https://juliaparallel.org/MPI.jl/stable/usage/">MPI</a> needs to be installed:</p><pre><code class="language-sh hljs">$ julia
julia&gt; using MPI
julia&gt; MPI.install_mpiexecjl()</code></pre><p>Run PeriLab with two processors:</p><pre><code class="language-sh hljs">$ mpiexecjl -n 2 julia -e &quot;using PeriLab; PeriLab.main()&quot; Dogbone.yaml -v</code></pre><h2 id="Training"><a class="docs-heading-anchor" href="#Training">Training</a><a id="Training-1"></a><a class="docs-heading-anchor-permalink" href="#Training" title="Permalink"></a></h2><p>The training input is given under the examples folder. The documentation and a video will follow.</p><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul></ul><h2 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" 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="PeriLab.main" href="#PeriLab.main"><code>PeriLab.main</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">main()</code></pre><p>Entry point for the PeriLab application.</p><p>This function serves as the entry point for the PeriLab application. It calls the core <code>main</code> function with the provided arguments.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/ea97b1515bb1d29e5292433923ac053839e9e99e/src/PeriLab.jl#L141-L147">source</a></section><section><div><pre><code class="language-julia hljs">main(filename::String, output_dir::String=&quot;&quot;, dry_run::Bool=false, verbose::Bool=false, debug::Bool=false, silent::Bool=false)</code></pre><p>Entry point for the PeriLab application.</p><p>This function serves as the entry point for the PeriLab application. It calls the core <code>main</code> function with the provided arguments.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: The filename of the input file.</li><li><code>output_dir::String</code>: The output directory.</li><li><code>dry_run::Bool=false</code>: Whether to run in dry-run mode.</li><li><code>verbose::Bool=false</code>: Whether to run in verbose mode.</li><li><code>debug::Bool=false</code>: Whether to run in debug mode.</li><li><code>silent::Bool=false</code>: Whether to run in silent mode.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/ea97b1515bb1d29e5292433923ac053839e9e99e/src/PeriLab.jl#L174-L188">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="PeriLab.get_examples" href="#PeriLab.get_examples"><code>PeriLab.get_examples</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_examples()</code></pre><p>Copy the examples folder to the current directory.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/ea97b1515bb1d29e5292433923ac053839e9e99e/src/PeriLab.jl#L160-L164">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basics/">« First Steps with PeriLab</a><a class="docs-footer-nextpage" href="../input_yaml/">Input File »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 09:58">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; MPI.install_mpiexecjl()</code></pre><p>Run PeriLab with two processors:</p><pre><code class="language-sh hljs">$ mpiexecjl -n 2 julia -e &quot;using PeriLab; PeriLab.main()&quot; Dogbone.yaml -v</code></pre><h2 id="Training"><a class="docs-heading-anchor" href="#Training">Training</a><a id="Training-1"></a><a class="docs-heading-anchor-permalink" href="#Training" title="Permalink"></a></h2><p>The training input is given under the examples folder. The documentation and a video will follow.</p><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul></ul><h2 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" 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="PeriLab.main" href="#PeriLab.main"><code>PeriLab.main</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">main()</code></pre><p>Entry point for the PeriLab application.</p><p>This function serves as the entry point for the PeriLab application. It calls the core <code>main</code> function with the provided arguments.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/df92f6c9d5965af0b50678e5c60e6daecb580345/src/PeriLab.jl#L141-L147">source</a></section><section><div><pre><code class="language-julia hljs">main(filename::String, output_dir::String=&quot;&quot;, dry_run::Bool=false, verbose::Bool=false, debug::Bool=false, silent::Bool=false)</code></pre><p>Entry point for the PeriLab application.</p><p>This function serves as the entry point for the PeriLab application. It calls the core <code>main</code> function with the provided arguments.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: The filename of the input file.</li><li><code>output_dir::String</code>: The output directory.</li><li><code>dry_run::Bool=false</code>: Whether to run in dry-run mode.</li><li><code>verbose::Bool=false</code>: Whether to run in verbose mode.</li><li><code>debug::Bool=false</code>: Whether to run in debug mode.</li><li><code>silent::Bool=false</code>: Whether to run in silent mode.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/df92f6c9d5965af0b50678e5c60e6daecb580345/src/PeriLab.jl#L174-L188">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="PeriLab.get_examples" href="#PeriLab.get_examples"><code>PeriLab.get_examples</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get_examples()</code></pre><p>Copy the examples folder to the current directory.</p></div><a class="docs-sourcelink" target="_blank" href="https://gitlab.com/dlr-PeriHub/PeriLab/-/tree/df92f6c9d5965af0b50678e5c60e6daecb580345/src/PeriLab.jl#L160-L164">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../basics/">« First Steps with PeriLab</a><a class="docs-footer-nextpage" href="../input_yaml/">Input File »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 10:26">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/man/input_yaml/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/man/mesh_input/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
1
2
11
12</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../input_yaml/">« Input File</a><a class="docs-footer-nextpage" href="../bond_filter/">Bond-Filter »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 09:58">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
12</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../input_yaml/">« Input File</a><a class="docs-footer-nextpage" href="../bond_filter/">Bond-Filter »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Wednesday 20 March 2024 10:26">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 54e927b

Please sign in to comment.