diff --git a/README.md b/README.md index 6d24586a..cae5fb7f 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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? @@ -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. diff --git a/tools/README.md b/tools/README.md index e9127c32..6a7a8622 100644 --- a/tools/README.md +++ b/tools/README.md @@ -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 \ @@ -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