Skip to content

Commit 054af48

Browse files
committed
JOSS review: README.md update to mention additional libraries needed by dependencies
1 parent 184ebbc commit 054af48

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ We have created channels on various platforms:
4545
- [PeriDEM on Gitter](https://gitter.im/PeriDEM/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
4646
* Gitter is absolutely open and easy to join.
4747
- [PeriDEM on slack](peridem.slack.com)
48-
* Send us an email if interested in joining the workspace.
48+
* Email us if interested in joining the workspace.
4949

5050
## Documentation
5151
[Doxygen generated documentation](https://prashjha.github.io/PeriDEM/) details functions and objects in the library.
@@ -275,7 +275,7 @@ We are moving in following key directions:
275275
- MPI parallelism for PeriDEM simulations. Issue is distributing particles to different
276276
processors and performing communication efficiently
277277
- Asynchronous parallelism within MPI? Currently, we use `Taskflow` to perform
278-
parallel for loops in a non-mpi simulation. In future, we will be interested in using
278+
parallel for loops in a non-mpi simulation. In the future, we will be interested in using
279279
multithreading combined with MPI to further speed-up the simulations
280280
- GPU parallelism?
281281

@@ -296,7 +296,7 @@ able to compile PeriDEM in ubuntu (>= 18.04) and mac.
296296
Feel free to reach out or open an issue. For more open
297297
discussion of issues and ideas, contact via
298298
[PeriDEM on Gitter](https://gitter.im/PeriDEM/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
299-
or [PeriDEM on slack](peridem.slack.com) (for slack, send us an email to join).
299+
or [PeriDEM on slack](peridem.slack.com) (for slack, email us to join).
300300
If you like some help, want to contribute, extend the code, or discuss new ideas,
301301
please do reach out to us.
302302

tools/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ Additional dependencies for running the examples:
5151
If all the dependencies are installed on the global path (e.g., `/usr/local/`),
5252
commands for building the PeriDEM code is as simple as
5353
```sh
54-
cmake -DEnable_Documentation=OFF # or ON \
54+
cmake -DEnable_Documentation=OFF
5555
-DEnable_Tests=ON \
56-
-DEnable_High_Load_Tests=OFF # ON if you want ctest to include high-load tests \
57-
-DDisable_Docker_MPI_Tests=ON # only for docker; OFF if you can run MPI in docker\
58-
-DVTK_DIR="${VTK_DIR}" # e.g., /usr/local/lib/cmake/vtk-9.3 \
59-
-DMETIS_DIR="${METIS_DIR}" # e.g., /usr/lib \
56+
-DEnable_High_Load_Tests=OFF \
57+
-DDisable_Docker_MPI_Tests=ON \
58+
-DVTK_DIR="${VTK_DIR}" \
59+
-DMETIS_DIR="${METIS_DIR}" \
6060
-DCMAKE_BUILD_TYPE=Release \
6161
<PeriDEM source directory>
6262

@@ -66,6 +66,9 @@ ctest --verbose
6666
```
6767

6868
## Installing dependencies
69+
70+
> :exclamation: There are some libraries (e.g., tbb) below that are required by our dependencies.
71+
6972
### Mac
7073
Brew can be used to install all dependencies in mac as follows
7174
```shell

0 commit comments

Comments
 (0)