Skip to content

update readme with correct options #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkr11 merged 1 commit into from
Jan 31, 2025
Merged

update readme with correct options #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ Final Assignment

## Dependencies

- Cmake 3.24
- Cmake 3.28.3
- Doxygen 1.9.8 (`sudo apt install doxygen`)
- Libxerces (`sudo apt install libxerces-c-dev`)

## Build

### Configuration
Expand All @@ -34,26 +33,26 @@ Final Assignment
cmake -S . -B build -DBUILD_TESTS=ON
```

To build with Intel's C++ compiler (```icx```/```icpx```), set the following options:
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)

```bash
cmake -S . -B build -DCMAKE_C_COMPILER=icx -DCMAKE_CXX_COMPILER=icpx
```

for other compilers add the necessary compiler id to the options.
```bash
cd build/tests
make -j $(nproc)
ctest
```

Using the build script in /script/
Using the build script in `/script/`

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

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

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

### Options
### CMake Options
```console
- ENABLE_BENCHMARK : enables benchmark mode with no printing of info and writing to files
- BUILD_TESTS : enables and builds the tests/ directory in the build directory
- ENABLE_OPENMP : enables OpenMP and support for multithreading
```

### Executable Options

```console
Options:
Expand Down