diff --git a/docs/documentation/getting-started.md b/docs/documentation/getting-started.md
index b891fa7bc..75b39270f 100644
--- a/docs/documentation/getting-started.md
+++ b/docs/documentation/getting-started.md
@@ -4,7 +4,7 @@
You can either download MFC's [latest release from GitHub](https://github.com/MFlowCode/MFC/releases/latest) or clone the repository:
-```shell {"id":"01HZFPNJRJKJ897YPN2PVNS40H"}
+```shell
git clone https://github.com/MFlowCode/MFC.git
cd MFC
```
@@ -19,13 +19,13 @@ Please select your desired configuration from the list bellow:
- **On supported clusters:** Load environment modules
-```shell {"id":"01HZFPNJRJKJ897YPN2QRHCH0W"}
+```shell
. ./mfc.sh load
```
- **Via [Aptitude](https://wiki.debian.org/Aptitude):**
-```shell {"id":"01HZFPNJRJKJ897YPN2RCHGDB3"}
+```shell
sudo apt update
sudo apt upgrade
sudo apt install tar wget make cmake gcc g++ \
@@ -36,7 +36,7 @@ sudo apt install tar wget make cmake gcc g++ \
- **Via [Pacman](https://wiki.archlinux.org/title/pacman):**
-```shell {"id":"01HZFPNJRJKJ897YPN2SYBY4ZR"}
+```shell
sudo pacman -Syu
sudo pacman -S base-devel coreutils \
git ninja gcc-fortran \
@@ -62,14 +62,12 @@ On Windows, you can either use Intel Compilers with the standard Microsoft toolc
Windows + Intel (Native)
Install the latest version of:
-
- [Microsoft Visual Studio Community](https://visualstudio.microsoft.com/)
- [IntelĀ® oneAPI Base Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html)
- [IntelĀ® oneAPI HPC Toolkit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/hpc-toolkit-download.html)
Then, in order to initialize your development environment, open a terminal window and run:
-
-```shell {"id":"01HZFPNJRJKJ897YPN2TFT7D3V"}
+```shell
"C:\Program Files (x86)\Intel\oneAPI\setvars.bat"
```
@@ -92,20 +90,20 @@ You can now follow the appropriate instructions for your distribution.
MacOS
-- **If you use [ZSH]** (Verify with `echo $SHELL`)
+ - **If you use [ZSH]** (Verify with `echo $SHELL`)
-```shell {"id":"01HZFPNJRJKJ897YPN2V88SDBX"}
+```shell
touch ~/.zshrc
open ~/.zshrc
```
-- **If you use [BASH]** (Verify with `echo $SHELL`)
-
-```shell {"id":"01HZFPNJRJKJ897YPN2XN8DXFZ"}
+ - **If you use [BASH]** (Verify with `echo $SHELL`)
+
+```shell
touch ~/.bash_profile
open ~/.bash_profile
```
-
+
An editor should open.
Please paste the following lines into it before saving the file.
If you wish to use a version of GNU's GCC other than 13, modify the first assignment.
@@ -113,7 +111,7 @@ These lines ensure that LLVM's Clang, and Apple's modified version of GCC, won't
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).
We do *not* support `clang` due to conflicts with the Silo dependency.
-```shell {"id":"01HZFPNJRJKJ897YPN2ZTZJWVH"}
+```shell
export MFC_GCC_VER=13
export CC=gcc-$MFC_GCC_VER
export CXX=g++-$MFC_GCC_VER
@@ -122,7 +120,7 @@ export FC=gfortran-$MFC_GCC_VER
**Close the open editor and terminal window**. Open a **new terminal** window before executing the commands below.
-```shell {"id":"01HZFPNJRJKJ897YPN31QHVWXQ"}
+```shell
brew install wget python cmake gcc@$MFC_GCC_VER mpich
```
@@ -135,21 +133,19 @@ They will download the dependencies MFC requires to build itself.
Docker is a lightweight, cross-platform, and performant alternative to Virtual Machines (VMs).
We build a Docker Image that contains the packages required to build and run MFC on your local machine.
-
+
First install Docker and Git:
-
- Windows: [Docker](https://docs.docker.com/get-docker/) + [Git](https://git-scm.com/downloads).
- macOS: `brew install git docker` (requires [Homebrew](https://brew.sh/)).
- Other systems:
-
-```shell {"id":"01HZFPNJRJKJ897YPN34Y40YAF"}
+```shell
sudo apt install git docker # Debian / Ubuntu via Aptitude
sudo pacman -S git docker # Arch Linux via Pacman
```
Once Docker and Git are installed on your system, clone MFC with
-```shell {"id":"01HZFPNJRJKJ897YPN383W8K9Y"}
+```shell
git clone https://github.com/MFlowCode/MFC
cd MFC
```
@@ -157,7 +153,7 @@ cd MFC
To fetch the prebuilt Docker image and enter an interactive bash session with the
recommended settings applied, run
-```shell {"id":"01HZFPNJRJKJ897YPN385851V3"}
+```shell
./mfc.sh docker # If on \*nix/macOS
.\mfc.bat docker # If on Windows
```
@@ -195,8 +191,7 @@ To only select a subset, use the `-t` (i.e., `--targets`) argument.
For a detailed list of options, arguments, and features, please refer to `./mfc.sh build --help`.
Most first-time users will want to build MFC using 8 threads (or more!) with MPI support:
-
-```shell {"id":"01HZFPNJRJKJ897YPN3A0RW6CX"}
+```shell
./mfc.sh build -j 8
```
@@ -210,7 +205,7 @@ Examples:
Run MFC's test suite with 8 threads:
-```shell {"id":"01HZFPNJRJKJ897YPN3DZTCCQ7"}
+```shell
./mfc.sh test -j 8
```
@@ -220,7 +215,7 @@ Please refer to the [Testing](testing.md) document for more information.
MFC has example cases in the `examples` folder. You can run such a case interactively using 2 tasks by typing:
-```shell {"id":"01HZFPNJRJKJ897YPN3FKXVQH9"}
+```shell
./mfc.sh run examples/2D_shockbubble/case.py -n 2
```