Skip to content

Commit 7b21a8f

Browse files
authored
Fix typos and enhance clarity in getting-started.md
Corrected typos and improved clarity in the documentation.
1 parent 06c7592 commit 7b21a8f

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

docs/documentation/getting-started.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ cd MFC
1212
## Build Environment
1313

1414
MFC can be built in multiple ways on various operating systems.
15-
Please select your desired configuration from the list bellow:
15+
Please select your desired configuration from the list below:
1616

1717
<summary><h2>*nix</h2></summary>
1818

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

2121
```shell
22-
. ./mfc.sh load
22+
source ./mfc.sh load
2323
```
2424

2525
- **Via Aptitude:**
@@ -34,8 +34,7 @@ sudo apt install tar wget make cmake gcc g++ \
3434
libblas-dev liblapack-dev
3535
```
3636

37-
If you wish to build MFC using [NVIDIA's NVHPC SDK](https://developer.nvidia.com/hpc-sdk),
38-
first follow the instructions [here](https://developer.nvidia.com/nvidia-hpc-sdk-downloads).
37+
If you wish to build MFC using [NVIDIA's NVHPC SDK](https://developer.nvidia.com/hpc-sdk), first follow the instructions [here](https://developer.nvidia.com/nvidia-hpc-sdk-downloads).
3938

4039

4140
<summary><h2>Windows</h2></summary>
@@ -116,12 +115,12 @@ MFC can be built with support for various (compile-time) features:
116115

117116
| Feature | Enable | Disable | Default | Description |
118117
| :----------------: | :---------: | :------------: | :-----: | --------------------------------------------------------------- |
119-
| **MPI** | `--mpi` | `--no-mpi` | On | Lets MFC run on multiple processors (and nodes) simultaneously. |
118+
| **MPI** | `--mpi` | `--no-mpi` | On | Allows MFC to run on multiple processors (and nodes). |
120119
| **GPU** | `--gpu` | `--no-gpu` | Off | Enables GPU acceleration via OpenACC. |
121120
| **Debug** | `--debug` | `--no-debug` | Off | Requests the compiler build MFC in debug mode. |
122-
| **GCov** | `--gcov` | `--no-gcov` | Off | Builds MFC with coverage flags on. |
123-
| **Unified Memory** | `--unified` | `--no-unified` | Off | Builds MFC with unified CPU/GPU memory (GH-200 superchip only) |
124-
| **Single** | `--single` | `--no-single` | Off | Builds MFC in single precision
121+
| **GCov** | `--gcov` | `--no-gcov` | Off | Build MFC with coverage flags on. |
122+
| **Unified Memory** | `--unified` | `--no-unified` | Off | Build MFC with unified CPU/GPU memory (GH200 superchip only) |
123+
| **Single** | `--single` | `--no-single` | Off | Build MFC in single precision
125124

126125
_⚠️ The `--gpu` option requires that your compiler supports OpenACC for Fortran for your target GPU architecture._
127126

@@ -139,26 +138,23 @@ Most first-time users will want to build MFC using 8 threads (or more!) with MPI
139138
./mfc.sh build -j 8
140139
```
141140

142-
Examples:
143-
141+
Some examples:
144142
- Build MFC using 8 threads with MPI and GPU acceleration: `./mfc.sh build --gpu -j 8`.
145143
- Build MFC using a single thread without MPI, GPU, and Debug support: `./mfc.sh build --no-mpi`.
146144
- Build MFC's `simulation` code in Debug mode with MPI and GPU support: `./mfc.sh build --debug --gpu -t simulation`.
147145

148146
## Using Containers
149-
Instead of building MFC from scratch, use containers to quickly access pre-built MFC along with its dependencies.
150147

151-
Run the latest MFC container.
148+
Instead of building MFC from scratch, you can use containers to quickly access a pre-built version of MFC and its dependencies.
149+
In brief, you can run the latest MFC container:
152150
```bash
153151
docker run -it --rm --entrypoint bash sbryngelson/mfc:latest-cpu
154152
```
155153
Please refer to the [Docker](https://mflowcode.github.io/documentation/docker.html) document for more information.
156154

157-
158155
## Running the Test Suite
159156

160157
Run MFC's test suite with 8 threads:
161-
162158
```shell
163159
./mfc.sh test -j 8
164160
```

0 commit comments

Comments
 (0)