Skip to content

Commit

Permalink
build based on 8831da8
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 17, 2024
1 parent 403e149 commit aff3039
Show file tree
Hide file tree
Showing 13 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · LaMEM.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>LaMEM.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 class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">Installation</span><ul><li><a class="tocitem" href="man/installation/">General instructions</a></li><li><a class="tocitem" href="man/installation_HPC/">Installation on HPC systems</a></li></ul></li><li><span class="tocitem">Create &amp; run LaMEM models from julia</span><ul><li><a class="tocitem" href="man/juliasetups/">Overview</a></li><li><a class="tocitem" href="man/juliasetup_example_sphere/">Example 1: Sphere</a></li><li><a class="tocitem" href="man/juliasetup_LaPalma/">Example 2: Volcano</a></li><li><a class="tocitem" href="man/juliasetup_TMSubduction/">Example 3: Subduction</a></li><li><a class="tocitem" href="man/juliasetup_pluto/">Notebooks</a></li><li><a class="tocitem" href="man/LaMEM_ModelFunctions/">Available functions</a></li></ul></li><li><a class="tocitem" href="man/runlamem/">Run LaMEM</a></li><li><a class="tocitem" href="man/readtimesteps/">Reading timesteps</a></li><li><a class="tocitem" href="man/listfunctions/">List of functions</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 class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/main/docs/src/index.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="LaMEM.jl"><a class="docs-heading-anchor" href="#LaMEM.jl">LaMEM.jl</a><a id="LaMEM.jl-1"></a><a class="docs-heading-anchor-permalink" href="#LaMEM.jl" title="Permalink"></a></h1><p>This is the julia interface to LaMEM, which does a number of handy things:</p><ul><li>It will automatically download a binary installation of LaMEM, along with the correct version of PETSc and mpiexec for your system. You can also use these binaries directly from your terminal, so you are not limited to julia. Gone are the days where you had to first spend hours or days to install PETSc on your system!</li><li>We provide a simple function to run LaMEM from julia (also in parallel).</li><li>We provide functions to read timesteps back into julia. </li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/installation/">General instructions »</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="Saturday 17 February 2024 16:18">Saturday 17 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · LaMEM.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>LaMEM.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 class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">Installation</span><ul><li><a class="tocitem" href="man/installation/">General instructions</a></li><li><a class="tocitem" href="man/installation_HPC/">Installation on HPC systems</a></li></ul></li><li><span class="tocitem">Create &amp; run LaMEM models from julia</span><ul><li><a class="tocitem" href="man/juliasetups/">Overview</a></li><li><a class="tocitem" href="man/juliasetup_example_sphere/">Example 1: Sphere</a></li><li><a class="tocitem" href="man/juliasetup_LaPalma/">Example 2: Volcano</a></li><li><a class="tocitem" href="man/juliasetup_TMSubduction/">Example 3: Subduction</a></li><li><a class="tocitem" href="man/juliasetup_pluto/">Notebooks</a></li><li><a class="tocitem" href="man/LaMEM_ModelFunctions/">Available functions</a></li></ul></li><li><a class="tocitem" href="man/runlamem/">Run LaMEM</a></li><li><a class="tocitem" href="man/readtimesteps/">Reading timesteps</a></li><li><a class="tocitem" href="man/listfunctions/">List of functions</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 class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/main/docs/src/index.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="LaMEM.jl"><a class="docs-heading-anchor" href="#LaMEM.jl">LaMEM.jl</a><a id="LaMEM.jl-1"></a><a class="docs-heading-anchor-permalink" href="#LaMEM.jl" title="Permalink"></a></h1><p>This is the julia interface to LaMEM, which does a number of handy things:</p><ul><li>It will automatically download a binary installation of LaMEM, along with the correct version of PETSc and mpiexec for your system. You can also use these binaries directly from your terminal, so you are not limited to julia. Gone are the days where you had to first spend hours or days to install PETSc on your system!</li><li>We provide a simple function to run LaMEM from julia (also in parallel).</li><li>We provide functions to read timesteps back into julia. </li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/installation/">General instructions »</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="Saturday 17 February 2024 16:38">Saturday 17 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
24 changes: 12 additions & 12 deletions dev/man/LaMEM_ModelFunctions/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/man/installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
pkg&gt;add LaMEM</code></pre><p>which will download the binaries along with PETSc and mpiexec for your system.</p><p>You can test if it works on your machine with</p><pre><code class="language-julia hljs">pkg&gt; test LaMEM</code></pre><h3 id="Running-LaMEM-from-the-julia-REPL"><a class="docs-heading-anchor" href="#Running-LaMEM-from-the-julia-REPL">Running LaMEM from the julia REPL</a><a id="Running-LaMEM-from-the-julia-REPL-1"></a><a class="docs-heading-anchor-permalink" href="#Running-LaMEM-from-the-julia-REPL" title="Permalink"></a></h3><p>Running LaMEM from within julia can be done with the <code>run_lamem</code> function:</p><article class="docstring"><header><a class="docstring-binding" id="LaMEM.Run.run_lamem" href="#LaMEM.Run.run_lamem"><code>LaMEM.Run.run_lamem</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">run_lamem(ParamFile::String, cores::Int64=1, args:String=&quot;&quot;; wait=true, deactivate_multithreads=true)</code></pre><p>This starts a LaMEM simulation, for using the parameter file <code>ParamFile</code> on <code>cores</code> number of cores. Optional additional command-line parameters can be specified with <code>args</code>.</p><p><strong>Example:</strong></p><p>You can call LaMEM with:</p><pre><code class="language-julia hljs">julia&gt; using LaMEM
julia&gt; ParamFile=&quot;../../input_models/BuildInSetups/FallingBlock_Multigrid.dat&quot;;
julia&gt; run_lamem(ParamFile)</code></pre><p>Do the same on 2 cores with a command-line argument as:</p><pre><code class="language-julia hljs">julia&gt; ParamFile=&quot;../../input_models/BuildInSetups/FallingBlock_Multigrid.dat&quot;;
julia&gt; run_lamem(ParamFile, 2, &quot;-nstep_max = 1&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/058b014733653659090e58575509592348ff91ff/src/run_lamem.jl#L23-L43">source</a></section><section><div><pre><code class="language-julia hljs">run_lamem(model::Model, cores::Int64=1, args:String=&quot;&quot;; wait=true)</code></pre><p>Performs a LaMEM run for the parameters that are specified in <code>model</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/058b014733653659090e58575509592348ff91ff/src/LaMEM_ModelGeneration/Model.jl#L190-L194">source</a></section></article><h3 id="Running-LaMEM-from-outside-julia"><a class="docs-heading-anchor" href="#Running-LaMEM-from-outside-julia">Running LaMEM from outside julia</a><a id="Running-LaMEM-from-outside-julia-1"></a><a class="docs-heading-anchor-permalink" href="#Running-LaMEM-from-outside-julia" title="Permalink"></a></h3><p>If you, for some reason, do not want to run LaMEM through julia but instead directly from the terminal or powershell, you will have to add the required dynamic libraries and executables. Do this with:</p><article class="docstring"><header><a class="docstring-binding" id="LaMEM.Run.show_paths_LaMEM" href="#LaMEM.Run.show_paths_LaMEM"><code>LaMEM.Run.show_paths_LaMEM</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">show_paths_LaMEM()</code></pre><p>The downloaded <code>LaMEM</code> binaries can also be called from outside julia (directly from the terminal). In that case, you will need to set load correct dynamic libraries (such as PETSc) and call the correct binaries.</p><p>This function shows this for your system. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/058b014733653659090e58575509592348ff91ff/src/utils_Run.jl#L39-L45">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../installation_HPC/">Installation on HPC systems »</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="Saturday 17 February 2024 16:18">Saturday 17 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; run_lamem(ParamFile, 2, &quot;-nstep_max = 1&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/8831da8b746852a268016821f69d78d032bded50/src/run_lamem.jl#L23-L43">source</a></section><section><div><pre><code class="language-julia hljs">run_lamem(model::Model, cores::Int64=1, args:String=&quot;&quot;; wait=true)</code></pre><p>Performs a LaMEM run for the parameters that are specified in <code>model</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/8831da8b746852a268016821f69d78d032bded50/src/LaMEM_ModelGeneration/Model.jl#L190-L194">source</a></section></article><h3 id="Running-LaMEM-from-outside-julia"><a class="docs-heading-anchor" href="#Running-LaMEM-from-outside-julia">Running LaMEM from outside julia</a><a id="Running-LaMEM-from-outside-julia-1"></a><a class="docs-heading-anchor-permalink" href="#Running-LaMEM-from-outside-julia" title="Permalink"></a></h3><p>If you, for some reason, do not want to run LaMEM through julia but instead directly from the terminal or powershell, you will have to add the required dynamic libraries and executables. Do this with:</p><article class="docstring"><header><a class="docstring-binding" id="LaMEM.Run.show_paths_LaMEM" href="#LaMEM.Run.show_paths_LaMEM"><code>LaMEM.Run.show_paths_LaMEM</code></a><span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">show_paths_LaMEM()</code></pre><p>The downloaded <code>LaMEM</code> binaries can also be called from outside julia (directly from the terminal). In that case, you will need to set load correct dynamic libraries (such as PETSc) and call the correct binaries.</p><p>This function shows this for your system. </p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/LaMEM.jl/blob/8831da8b746852a268016821f69d78d032bded50/src/utils_Run.jl#L39-L45">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Home</a><a class="docs-footer-nextpage" href="../installation_HPC/">Installation on HPC systems »</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="Saturday 17 February 2024 16:38">Saturday 17 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit aff3039

Please sign in to comment.