Skip to content

Commit f235efa

Browse files
committed
More updates to README.
1 parent e3c374f commit f235efa

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ We provide complete and executable source codes for our `allgatherv`, `sample so
1414
To compile this project you need:
1515
- A C++17-ready compiler such as `g++` version 9 or higher or `clang` version 11 or higher.
1616
- [OpenMPI](https://www.open-mpi.org/) or [Intel MPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html#gs.pr0oht)
17-
- (Boost)
17+
- (Boost) disabled by default, use `-DKAMPING_EXAMPLES_USE_BOOST=ON` to enable, or fetch from cmake by providing `-DKAMPING_EXAMPLES_USE_BOOST_AS_SUBMODULE=ON`
1818
- CMake 3.26
1919

20-
For generating job files:
20+
For generating job files from experiments suites from `experiment_suites/`:
2121
- python3
22-
- PyYAML (`pip install pyyaml`)
22+
- PyYAML (`pip install pyyaml` or use the `Pipfile` provided in `kaval/`)
2323

2424

2525

2626
### Compiling
2727

2828
```shell
29-
cmake -B build --preset experiments
29+
cmake --preset experiments
3030
cmake --build --preset experiments --parallel
3131
```
3232
(Note: in the anonymized version, it is quite likely that the source code in this repository will not compile out of the box)
@@ -66,3 +66,5 @@ python ./kaval/run-experiments.py bfs \
6666
```
6767
this will create a directory containing generic MPI jobfiles for all experiment configurations.
6868

69+
### Making plots
70+
Scripts for parsing log files and generating plots can be found in the `evaluation/` subdirectory

0 commit comments

Comments
 (0)