Skip to content

Commit a052d35

Browse files
authored
Merge pull request #154 from jkr11/readme2
update readme with correct options
2 parents 6efc1c4 + e3c0a71 commit a052d35

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Final Assignment
55

66
## Dependencies
77

8-
- Cmake 3.24
8+
- Cmake 3.28.3
99
- Doxygen 1.9.8 (`sudo apt install doxygen`)
1010
- Libxerces (`sudo apt install libxerces-c-dev`)
11-
1211
## Build
1312

1413
### Configuration
@@ -34,26 +33,26 @@ Final Assignment
3433
cmake -S . -B build -DBUILD_TESTS=ON
3534
```
3635

37-
To build with Intel's C++ compiler (```icx```/```icpx```), set the following options:
36+
To build with Intel's C++ compiler (```icx```/```icpx```), set the following options (currently this is on the [`coolmuc_test`](https://github.com/jkr11/MolSim/tree/coolmuc_test) branch, but it works locally)
3837

3938
```bash
4039
cmake -S . -B build -DCMAKE_C_COMPILER=icx -DCMAKE_CXX_COMPILER=icpx
4140
```
42-
41+
for other compilers add the necessary compiler id to the options.
4342
```bash
4443
cd build/tests
4544
make -j $(nproc)
4645
ctest
4746
```
4847

49-
Using the build script in /script/
48+
Using the build script in `/script/`
5049

5150
- Build the project using the provided build script by using source, add `-t` to also build and run tests, add `-b` to
52-
enable the BENCHMARK cmake macro
51+
enable the BENCHMARK cmake macro and `-p` to enable OpenMP.
5352

5453
```bash
5554
cd MolSim/scripts
56-
source build <CMAKE_BUILD_TYPE= Release (default) | Debug | asan | asan-quiet> [-t|--test] [-b|--benchmark]
55+
source build <CMAKE_BUILD_TYPE= Release (default) | Debug | asan | asan-quiet> [-t|--test] [-b|--benchmark] [-p|--parallel]
5756
```
5857

5958
- Set the Input file by selecting the corresponding number during the script execution
@@ -79,7 +78,14 @@ Using the build script in /script/
7978
- `$INPUT` contains the location of the selected input file
8079
- Please note that `$BUILD` and `$INPUT` are only available if the scripts are executed via source.
8180

82-
### Options
81+
### CMake Options
82+
```console
83+
- ENABLE_BENCHMARK : enables benchmark mode with no printing of info and writing to files
84+
- BUILD_TESTS : enables and builds the tests/ directory in the build directory
85+
- ENABLE_OPENMP : enables OpenMP and support for multithreading
86+
```
87+
88+
### Executable Options
8389

8490
```console
8591
Options:

0 commit comments

Comments
 (0)