Skip to content

Commit 86b1896

Browse files
author
MFC Action
committed
Docs @ 9fbc566
1 parent 70129b6 commit 86b1896

28 files changed

+336
-499
lines changed

documentation/doxygen_crawl.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -117,25 +117,25 @@
117117
<a href="md_getting-started.html#autotoc_md102"/>
118118
<a href="md_getting-started.html#autotoc_md103"/>
119119
<a href="md_getting-started.html#autotoc_md99"/>
120-
<a href="md_gpuDebugging.html"/>
121-
<a href="md_gpuDebugging.html#autotoc_md105"/>
122-
<a href="md_gpuDebugging.html#autotoc_md106"/>
123-
<a href="md_gpuDebugging.html#autotoc_md107"/>
124-
<a href="md_gpuDebugging.html#autotoc_md108"/>
125-
<a href="md_gpuDebugging.html#autotoc_md109"/>
126-
<a href="md_gpuDebugging.html#autotoc_md110"/>
127-
<a href="md_gpuDebugging.html#autotoc_md111"/>
128-
<a href="md_gpuDebugging.html#autotoc_md112"/>
129-
<a href="md_gpuDebugging.html#autotoc_md113"/>
130-
<a href="md_gpuDebugging.html#autotoc_md114"/>
131120
<a href="md_gpuParallelization.html"/>
132-
<a href="md_gpuParallelization.html#autotoc_md117"/>
121+
<a href="md_gpuParallelization.html#autotoc_md106"/>
122+
<a href="md_gpuParallelization.html#autotoc_md107"/>
123+
<a href="md_gpuParallelization.html#autotoc_md108"/>
124+
<a href="md_gpuParallelization.html#autotoc_md110"/>
125+
<a href="md_gpuParallelization.html#autotoc_md112"/>
126+
<a href="md_gpuParallelization.html#autotoc_md114"/>
127+
<a href="md_gpuParallelization.html#autotoc_md116"/>
133128
<a href="md_gpuParallelization.html#autotoc_md118"/>
134129
<a href="md_gpuParallelization.html#autotoc_md119"/>
130+
<a href="md_gpuParallelization.html#autotoc_md120"/>
135131
<a href="md_gpuParallelization.html#autotoc_md121"/>
132+
<a href="md_gpuParallelization.html#autotoc_md122"/>
136133
<a href="md_gpuParallelization.html#autotoc_md123"/>
134+
<a href="md_gpuParallelization.html#autotoc_md124"/>
137135
<a href="md_gpuParallelization.html#autotoc_md125"/>
136+
<a href="md_gpuParallelization.html#autotoc_md126"/>
138137
<a href="md_gpuParallelization.html#autotoc_md127"/>
138+
<a href="md_gpuParallelization.html#autotoc_md128"/>
139139
<a href="md_papers.html"/>
140140
<a href="md_readme.html"/>
141141
<a href="md_readme.html#autotoc_md131"/>

documentation/md_getting-started.html

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,7 @@ <h1><a class="anchor" id="autotoc_md99"></a>
144144
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md100"></a>
145145
Build Environment</h1>
146146
<p>MFC can be built in multiple ways on various operating systems. Please select your desired configuration from the list bellow:</p>
147-
<details >
148-
<summary >
149-
*nix</summary>
150-
<p></p>
147+
<h2>*nix</h2>
151148
<ul>
152149
<li><b>On supported clusters:</b> Load environment modules</li>
153150
</ul>
@@ -160,14 +157,10 @@ <h1><a class="anchor" id="autotoc_md99"></a>
160157
<div class="line">sudo apt install tar wget make cmake gcc g++ \</div>
161158
<div class="line"> python3 python3-dev python3-venv \</div>
162159
<div class="line"> openmpi-bin libopenmpi-dev \</div>
163-
<div class="line"> libhdf5-dev libfftw3-dev</div>
164-
</div><!-- fragment --><p>If you wish to build MFC using <a href="https://developer.nvidia.com/hpc-sdk">NVidia's NVHPC SDK</a>, first follow the instructions <a href="https://developer.nvidia.com/nvidia-hpc-sdk-downloads">here</a>.</p>
165-
<p></p>
166-
</details>
167-
<details >
168-
<summary >
169-
Windows</summary>
170-
<p></p>
160+
<div class="line"> libhdf5-dev libfftw3-dev \</div>
161+
<div class="line"> libblas-dev liblapack-dev</div>
162+
</div><!-- fragment --><p>If you wish to build MFC using <a href="https://developer.nvidia.com/hpc-sdk">NVIDIA's NVHPC SDK</a>, first follow the instructions <a href="https://developer.nvidia.com/nvidia-hpc-sdk-downloads">here</a>.</p>
163+
<h2>Windows</h2>
171164
<p>On Windows, you can either use Intel Compilers with the standard Microsoft toolchain, or the <a href="https://docs.microsoft.com/en-us/windows/wsl/">Windows Subsystem for Linux (WSL)</a> for a Linux experience.</p>
172165
<details >
173166
<summary >
@@ -207,20 +200,13 @@ <h1><a class="anchor" id="autotoc_md99"></a>
207200
<p>You will also have access to the <code>.sln</code> Microsoft Visual Studio solution files for an IDE (Integrated Development Environment).</p>
208201
<p></p>
209202
</details>
210-
<p></p>
211-
</details>
212-
<details >
213-
<summary >
214-
MacOS</summary>
215-
<p></p>
203+
<h3>MacOS</h3>
216204
<p>Using <a href="https://brew.sh/">Homebrew</a> you can install the necessary dependencies before configuring your environment:</p>
217-
<div class="fragment"><div class="line">brew install coreutils python cmake fftw hdf5 gcc boost open-mpi</div>
205+
<div class="fragment"><div class="line">brew install coreutils python cmake fftw hdf5 gcc boost open-mpi lapack</div>
218206
<div class="line">echo -e &quot;export BOOST_INCLUDE=&#39;$(brew --prefix --installed boost)/include&#39;&quot; | tee -a ~/.bash_profile ~/.zshrc</div>
219207
<div class="line">. ~/.bash_profile 2&gt;/dev/null || . ~/.zshrc 2&gt;/dev/null</div>
220208
<div class="line">! [ -z &quot;${BOOST_INCLUDE+x}&quot; ] &amp;&amp; echo &#39;Environment is ready!&#39; || echo &#39;Error: $BOOST_INCLUDE is unset. Please adjust the previous commands to fit with your environment.&#39;</div>
221209
</div><!-- fragment --><p>They will download the dependencies MFC requires to build itself.</p>
222-
<p></p>
223-
</details>
224210
<h1><a class="anchor" id="autotoc_md101"></a>
225211
Building MFC</h1>
226212
<p>MFC can be built with support for various (compile-time) features:</p>

documentation/md_gpuDebugging.html

Lines changed: 0 additions & 300 deletions
This file was deleted.

0 commit comments

Comments
 (0)