Update docs

This commit is contained in:
2023-12-05 19:26:29 +01:00
parent 1913e04594
commit a9369e0274
13 changed files with 374 additions and 354 deletions

View File

@@ -114,7 +114,7 @@ Operating systems</h2>
</ul>
</li>
<li>MacOS<ul>
<li>Might work, but hasn't been tested</li>
<li>Will most likely not work due to the use of getopt, which is GNU specific.</li>
</ul>
</li>
<li>Windows<ul>
@@ -188,7 +188,17 @@ Running scripts</h3>
Batch system</h2>
<p>For the <b>phase_transition_mpi</b> program, there are scripts in the **./slurm_scripts** directory that come along with it. This is to be able to run it on a batch system using Slurm if you have access to one. The only program that should be executed by the user is the **./slurm_scripts/execute.script** script. You can see how to use this script by doing:</p>
<div class="fragment"><div class="line">./slurm_scripts/execute.script --help</div>
</div><!-- fragment --><p>This is the recommended way to use this program as it takes approximately 90 minutes to complete when using 8 processes where each process has 10 threads.</p>
</div><!-- fragment --><p>This is the recommended way of using the program. Here is a table using different parameters on the Fox cluster:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Lattice size </th><th class="markdownTableHeadNone">Samples </th><th class="markdownTableHeadNone">Processes </th><th class="markdownTableHeadNone">threads </th><th class="markdownTableHeadNone">Time (seconds) </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">20 </td><td class="markdownTableBodyNone">1e7 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">133.735 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">40 </td><td class="markdownTableBodyNone">1e7 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">814.126 </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">60 </td><td class="markdownTableBodyNone">1e7 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">10 </td><td class="markdownTableBodyNone">2575.33 </td></tr>
</table>
<p>If you happen to have such a system available to you, then you should clone this repo on that system, then compile the MPI program like this:</p>
<div class="fragment"><div class="line">make bin/phase_transition_mpi</div>
</div><!-- fragment --><p>After compiling, you can schedule it by using the **./slurm_scripts/execute.script**:</p>