Skip to content

Commit

Permalink
JOSS review: README.md update to mention additional libraries needed …
Browse files Browse the repository at this point in the history
…by dependencies
  • Loading branch information
prashjha committed Feb 7, 2025
1 parent 184ebbc commit 054af48
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ We have created channels on various platforms:
- [PeriDEM on Gitter](https://gitter.im/PeriDEM/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
* Gitter is absolutely open and easy to join.
- [PeriDEM on slack](peridem.slack.com)
* Send us an email if interested in joining the workspace.
* Email us if interested in joining the workspace.

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

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

Expand Down
13 changes: 8 additions & 5 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ Additional dependencies for running the examples:
If all the dependencies are installed on the global path (e.g., `/usr/local/`),
commands for building the PeriDEM code is as simple as
```sh
cmake -DEnable_Documentation=OFF # or ON \
cmake -DEnable_Documentation=OFF
-DEnable_Tests=ON \
-DEnable_High_Load_Tests=OFF # ON if you want ctest to include high-load tests \
-DDisable_Docker_MPI_Tests=ON # only for docker; OFF if you can run MPI in docker\
-DVTK_DIR="${VTK_DIR}" # e.g., /usr/local/lib/cmake/vtk-9.3 \
-DMETIS_DIR="${METIS_DIR}" # e.g., /usr/lib \
-DEnable_High_Load_Tests=OFF \
-DDisable_Docker_MPI_Tests=ON \
-DVTK_DIR="${VTK_DIR}" \
-DMETIS_DIR="${METIS_DIR}" \
-DCMAKE_BUILD_TYPE=Release \
<PeriDEM source directory>

Expand All @@ -66,6 +66,9 @@ ctest --verbose
```

## Installing dependencies

> :exclamation: There are some libraries (e.g., tbb) below that are required by our dependencies.
### Mac
Brew can be used to install all dependencies in mac as follows
```shell
Expand Down

0 comments on commit 054af48

Please sign in to comment.