FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Cory Balaton
2023-12-05 19:32:43 +01:00
parent 53900b1205
commit 5eff0b0d37
33 changed files with 564 additions and 1159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.html
View File

@@ -152,17 +152,17 @@ Compiling</h1>
Normal binaries</h2>
<p>Compiling regular binaries is as easy as running this command:</p>
<div class="fragment"><div class="line">make</div>
</div><!-- fragment --><p>The binaries will then be inside the **./bin** directory.</p>
</div><!-- fragment --><p>The binaries will then be inside the <b>bin</b> directory.</p>
<h2><a class="anchor" id="autotoc_md7"></a>
Profiling binaries</h2>
<p>If you want to profile the programs (specifically the MPI program), then run this command</p>
<div class="fragment"><div class="line">make profile</div>
</div><!-- fragment --><p>The binaries will then be inside the **./prof** directory.</p>
</div><!-- fragment --><p>The binaries will then be inside the <b>prof</b> directory.</p>
<h2><a class="anchor" id="autotoc_md8"></a>
Debugging binaries</h2>
<p>If you want to debug the code, then use this command:</p>
<div class="fragment"><div class="line">make debug</div>
</div><!-- fragment --><p>The binaries will then be inside the **./debug** directory.</p>
</div><!-- fragment --><p>The binaries will then be inside the <b>debug</b> directory.</p>
<h1><a class="anchor" id="autotoc_md9"></a>
Running programs</h1>
<h2><a class="anchor" id="autotoc_md10"></a>
@@ -186,7 +186,7 @@ Running scripts</h3>
<div class="fragment"><div class="line">python3 python_scripts/&lt;script-name&gt;</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md14"></a>
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>
<p>For the <b>phase_transition_mpi</b> program, there are scripts in the <b>slurm_scripts</b> 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 <b>slurm_scripts/execute.script</b> 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 of using the program. Here is a table using different parameters on the Fox cluster:</p>
<table class="markdownTable">
@@ -201,7 +201,7 @@ Batch system</h2>
</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>
</div><!-- fragment --><p>After compiling, you can schedule it by using the <b>slurm_scripts/execute.script</b>:</p>
<div class="fragment"><div class="line">./slurm_scripts/execute.script &lt;parameters&gt;</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md15"></a>
Performance</h1>