build based on c6c2f9f

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-05T19:31:31","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-19T18:38:13","documenter_version":"1.5.0"}}

dev/index.html

@@ -24,4 +24,4 @@
     tasks=make_tasks(tm)
 )
 
-start(job, ARGS)</code></pre><p>This example starts a simulation for the Ising model on the 10×10 lattice for 20 different temperatures. Using the function <a href="jobtools.html#Carlo.start-Tuple{JobInfo, AbstractVector{&lt;:AbstractString}}"><code>start(job::JobInfo, ARGS)</code></a> enables the Carlo CLI when we  execute the script above as follows.</p><pre><code class="language-bash hljs">./myjob --help</code></pre><p>The command line interface allows (re)starting a job, merging preliminary results, and showing the completion status of a calculation.</p><h3 id="Starting-jobs"><a class="docs-heading-anchor" href="#Starting-jobs">Starting jobs</a><a id="Starting-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Starting-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob run</code></pre><p>This will start a simulation on a single core. To use multiple cores, use MPI.</p><pre><code class="language-bash hljs">mpirun -n $num_cores ./myjob run</code></pre><p>Once the simulation is started, a directory <code>myjob.data</code> will be created to store all simulation data. The name of the directory corresponds to the first argument of <code>JobInfo</code>. Usually that will be <code>@__FILE__</code>, but you could also collect your simulation data in a different directory.</p><p>The data directory will contain hdf5 files for each task of the job that contain checkpointing snapshots and measurement results. Once the job is done, Carlo will average the measurement data for you and produce the file <code>myjob.results.json</code> in the same directory as the <code>myjob.data</code> directory. This file contains means and errorbars of all observables. See <a href="resulttools.html#result_tools">ResultTools</a> for some tips on consuming this file back into julia for your plotting or other postprocessing.</p><h3 id="Job-status"><a class="docs-heading-anchor" href="#Job-status">Job status</a><a id="Job-status-1"></a><a class="docs-heading-anchor-permalink" href="#Job-status" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob status</code></pre><p>Use this command to find out the state of the simulation. It will show a table with the number of completed measurement sweeps, the target number of sweeps, the numbers of runs, and the fraction of them that is thermalized.</p><p>The fraction is defined as thermalization sweeps completed/total thermalization sweeps needed.</p><h3 id="Merging-jobs"><a class="docs-heading-anchor" href="#Merging-jobs">Merging jobs</a><a id="Merging-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Merging-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob merge</code></pre><p>Usually Carlo will automatically merge results once a job is complete, but when you are impatient and you want to check on results of a running or aborted job, this command is your friend. It will produce a <code>myjob.results.json</code> file containing the averages of the currently available data.</p><h3 id="Deleting-jobs"><a class="docs-heading-anchor" href="#Deleting-jobs">Deleting jobs</a><a id="Deleting-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Deleting-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob delete</code></pre><p>This deletes <code>myjob.data</code> and <code>myjob.results.json</code>. Of course, you should archive your simulation data instead of deleting them. However, if you made an error in a previous simulation, keep in mind that by default Carlo will continue it from the checkpoints.</p><p>For that case of restarting a job there is a handy shortcut as well</p><pre><code class="language-bash hljs">./myjob run --restart</code></pre><h2 id="Shortcuts"><a class="docs-heading-anchor" href="#Shortcuts">Shortcuts</a><a id="Shortcuts-1"></a><a class="docs-heading-anchor-permalink" href="#Shortcuts" title="Permalink"></a></h2><p>All commands here have shortcut versions that you can view in the help.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="abstract_mc.html">Implementing your algorithm »</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.5.0 on <span class="colophon-date" title="Monday 5 August 2024 19:31">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+start(job, ARGS)</code></pre><p>This example starts a simulation for the Ising model on the 10×10 lattice for 20 different temperatures. Using the function <a href="jobtools.html#Carlo.start-Tuple{JobInfo, AbstractVector{&lt;:AbstractString}}"><code>start(job::JobInfo, ARGS)</code></a> enables the Carlo CLI when we  execute the script above as follows.</p><pre><code class="language-bash hljs">./myjob --help</code></pre><p>The command line interface allows (re)starting a job, merging preliminary results, and showing the completion status of a calculation.</p><h3 id="Starting-jobs"><a class="docs-heading-anchor" href="#Starting-jobs">Starting jobs</a><a id="Starting-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Starting-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob run</code></pre><p>This will start a simulation on a single core. To use multiple cores, use MPI.</p><pre><code class="language-bash hljs">mpirun -n $num_cores ./myjob run</code></pre><p>Once the simulation is started, a directory <code>myjob.data</code> will be created to store all simulation data. The name of the directory corresponds to the first argument of <code>JobInfo</code>. Usually that will be <code>@__FILE__</code>, but you could also collect your simulation data in a different directory.</p><p>The data directory will contain hdf5 files for each task of the job that contain checkpointing snapshots and measurement results. Once the job is done, Carlo will average the measurement data for you and produce the file <code>myjob.results.json</code> in the same directory as the <code>myjob.data</code> directory. This file contains means and errorbars of all observables. See <a href="resulttools.html#result_tools">ResultTools</a> for some tips on consuming this file back into julia for your plotting or other postprocessing.</p><h3 id="Job-status"><a class="docs-heading-anchor" href="#Job-status">Job status</a><a id="Job-status-1"></a><a class="docs-heading-anchor-permalink" href="#Job-status" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob status</code></pre><p>Use this command to find out the state of the simulation. It will show a table with the number of completed measurement sweeps, the target number of sweeps, the numbers of runs, and the fraction of them that is thermalized.</p><p>The fraction is defined as thermalization sweeps completed/total thermalization sweeps needed.</p><h3 id="Merging-jobs"><a class="docs-heading-anchor" href="#Merging-jobs">Merging jobs</a><a id="Merging-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Merging-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob merge</code></pre><p>Usually Carlo will automatically merge results once a job is complete, but when you are impatient and you want to check on results of a running or aborted job, this command is your friend. It will produce a <code>myjob.results.json</code> file containing the averages of the currently available data.</p><h3 id="Deleting-jobs"><a class="docs-heading-anchor" href="#Deleting-jobs">Deleting jobs</a><a id="Deleting-jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Deleting-jobs" title="Permalink"></a></h3><pre><code class="language-bash hljs">./myjob delete</code></pre><p>This deletes <code>myjob.data</code> and <code>myjob.results.json</code>. Of course, you should archive your simulation data instead of deleting them. However, if you made an error in a previous simulation, keep in mind that by default Carlo will continue it from the checkpoints.</p><p>For that case of restarting a job there is a handy shortcut as well</p><pre><code class="language-bash hljs">./myjob run --restart</code></pre><h2 id="Shortcuts"><a class="docs-heading-anchor" href="#Shortcuts">Shortcuts</a><a id="Shortcuts-1"></a><a class="docs-heading-anchor-permalink" href="#Shortcuts" title="Permalink"></a></h2><p>All commands here have shortcut versions that you can view in the help.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="abstract_mc.html">Implementing your algorithm »</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.5.0 on <span class="colophon-date" title="Monday 19 August 2024 18:38">Monday 19 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>