Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 19a4404

Browse files
committedJun 3, 2024·
fixed getting_started.md
1 parent 18dfa6a commit 19a4404

File tree

1 file changed

+20
-25
lines changed

1 file changed

+20
-25
lines changed
 

‎docs/documentation/getting-started.md

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
You can either download MFC's [latest release from GitHub](https://github.com/MFlowCode/MFC/releases/latest) or clone the repository:
66

7-
```shell {"id":"01HZFPNJRJKJ897YPN2PVNS40H"}
7+
```shell
88
git clone https://github.com/MFlowCode/MFC.git
99
cd MFC
1010
```
@@ -19,13 +19,13 @@ Please select your desired configuration from the list bellow:
1919

2020
- **On supported clusters:** Load environment modules
2121

22-
```shell {"id":"01HZFPNJRJKJ897YPN2QRHCH0W"}
22+
```shell
2323
. ./mfc.sh load
2424
```
2525

2626
- **Via [Aptitude](https://wiki.debian.org/Aptitude):**
2727

28-
```shell {"id":"01HZFPNJRJKJ897YPN2RCHGDB3"}
28+
```shell
2929
sudo apt update
3030
sudo apt upgrade
3131
sudo apt install tar wget make cmake gcc g++ \
@@ -36,7 +36,7 @@ sudo apt install tar wget make cmake gcc g++ \
3636

3737
- **Via [Pacman](https://wiki.archlinux.org/title/pacman):**
3838

39-
```shell {"id":"01HZFPNJRJKJ897YPN2SYBY4ZR"}
39+
```shell
4040
sudo pacman -Syu
4141
sudo pacman -S base-devel coreutils \
4242
git ninja gcc-fortran \
@@ -62,14 +62,12 @@ On Windows, you can either use Intel Compilers with the standard Microsoft toolc
6262
<summary><h3>Windows + Intel (Native)</h3></summary>
6363

6464
Install the latest version of:
65-
6665
- [Microsoft Visual Studio Community](https://visualstudio.microsoft.com/)
6766
- [Intel® oneAPI Base Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html)
6867
- [Intel® oneAPI HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit-download.html)
6968

7069
Then, in order to initialize your development environment, open a terminal window and run:
71-
72-
```shell {"id":"01HZFPNJRJKJ897YPN2TFT7D3V"}
70+
```shell
7371
"C:\Program Files (x86)\Intel\oneAPI\setvars.bat"
7472
```
7573

@@ -92,28 +90,28 @@ You can now follow the appropriate instructions for your distribution.
9290
<details>
9391
<summary><h3>MacOS</h3></summary>
9492

95-
- **If you use [ZSH]** (Verify with `echo $SHELL`)
93+
- **If you use [ZSH]** (Verify with `echo $SHELL`)
9694

97-
```shell {"id":"01HZFPNJRJKJ897YPN2V88SDBX"}
95+
```shell
9896
touch ~/.zshrc
9997
open ~/.zshrc
10098
```
10199

102-
- **If you use [BASH]** (Verify with `echo $SHELL`)
103-
104-
```shell {"id":"01HZFPNJRJKJ897YPN2XN8DXFZ"}
100+
- **If you use [BASH]** (Verify with `echo $SHELL`)
101+
102+
```shell
105103
touch ~/.bash_profile
106104
open ~/.bash_profile
107105
```
108-
106+
109107
An editor should open.
110108
Please paste the following lines into it before saving the file.
111109
If you wish to use a version of GNU's GCC other than 13, modify the first assignment.
112110
These lines ensure that LLVM's Clang, and Apple's modified version of GCC, won't be used to compile MFC.
113111
Further reading on `open-mpi` incompatibility with `clang`-based `gcc` on macOS: [here](https://stackoverflow.com/questions/27930481/how-to-build-openmpi-with-homebrew-and-gcc-4-9).
114112
We do *not* support `clang` due to conflicts with the Silo dependency.
115113

116-
```shell {"id":"01HZFPNJRJKJ897YPN2ZTZJWVH"}
114+
```shell
117115
export MFC_GCC_VER=13
118116
export CC=gcc-$MFC_GCC_VER
119117
export CXX=g++-$MFC_GCC_VER
@@ -122,7 +120,7 @@ export FC=gfortran-$MFC_GCC_VER
122120

123121
**Close the open editor and terminal window**. Open a **new terminal** window before executing the commands below.
124122

125-
```shell {"id":"01HZFPNJRJKJ897YPN31QHVWXQ"}
123+
```shell
126124
brew install wget python cmake gcc@$MFC_GCC_VER mpich
127125
```
128126

@@ -135,29 +133,27 @@ They will download the dependencies MFC requires to build itself.
135133

136134
Docker is a lightweight, cross-platform, and performant alternative to Virtual Machines (VMs).
137135
We build a Docker Image that contains the packages required to build and run MFC on your local machine.
138-
136+
139137
First install Docker and Git:
140-
141138
- Windows: [Docker](https://docs.docker.com/get-docker/) + [Git](https://git-scm.com/downloads).
142139
- macOS: `brew install git docker` (requires [Homebrew](https://brew.sh/)).
143140
- Other systems:
144-
145-
```shell {"id":"01HZFPNJRJKJ897YPN34Y40YAF"}
141+
```shell
146142
sudo apt install git docker # Debian / Ubuntu via Aptitude
147143
sudo pacman -S git docker # Arch Linux via Pacman
148144
```
149145

150146
Once Docker and Git are installed on your system, clone MFC with
151147

152-
```shell {"id":"01HZFPNJRJKJ897YPN383W8K9Y"}
148+
```shell
153149
git clone https://github.com/MFlowCode/MFC
154150
cd MFC
155151
```
156152

157153
To fetch the prebuilt Docker image and enter an interactive bash session with the
158154
recommended settings applied, run
159155

160-
```shell {"id":"01HZFPNJRJKJ897YPN385851V3"}
156+
```shell
161157
./mfc.sh docker # If on \*nix/macOS
162158
.\mfc.bat docker # If on Windows
163159
```
@@ -195,8 +191,7 @@ To only select a subset, use the `-t` (i.e., `--targets`) argument.
195191
For a detailed list of options, arguments, and features, please refer to `./mfc.sh build --help`.
196192

197193
Most first-time users will want to build MFC using 8 threads (or more!) with MPI support:
198-
199-
```shell {"id":"01HZFPNJRJKJ897YPN3A0RW6CX"}
194+
```shell
200195
./mfc.sh build -j 8
201196
```
202197

@@ -210,7 +205,7 @@ Examples:
210205

211206
Run MFC's test suite with 8 threads:
212207

213-
```shell {"id":"01HZFPNJRJKJ897YPN3DZTCCQ7"}
208+
```shell
214209
./mfc.sh test -j 8
215210
```
216211

@@ -220,7 +215,7 @@ Please refer to the [Testing](testing.md) document for more information.
220215

221216
MFC has example cases in the `examples` folder. You can run such a case interactively using 2 tasks by typing:
222217

223-
```shell {"id":"01HZFPNJRJKJ897YPN3FKXVQH9"}
218+
```shell
224219
./mfc.sh run examples/2D_shockbubble/case.py -n 2
225220
```
226221

0 commit comments

Comments
 (0)
Please sign in to comment.