Skip to content

Some updates to the Quick start guide section in README.md #1407

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
landinjm merged 2 commits into from
Oct 15, 2026
Merged

Some updates to the Quick start guide section in README.md #1407

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b148b2
Some updates to the Quick start guide in README.md
david-montiel-t Oct 13, 2026
25addbe
Correction to environment var. name on README.md
david-montiel-t Oct 13, 2026
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
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,20 @@ Install the required dependencies:
- p4est
- deal.II [9.6.0+]

Configure, compile, and install the main library. We recommend setting the `PRISMS_PF_DIR` variable into your rc file so you have permanent access to it.
Before building and installing PRISMS-PF, ensure that the environment variable `DEAL_II_DIR` is set to the directory where deal.II is installed:
```
export PRISMS_PF_DIR="path/to/install"
export DEAL_II_DIR=</absolute/path/to/deal.II/install>
```

It is recommended to also add this line to your rc file (for example, ~/.bashrc, ~/.zshrc, etc.) so that `DEAL_II_DIR` is automatically set every time a terminal is opened.

Similarly, choose an installation directory for PRISMS-PF and set the `PRISMS_PF_DIR` environment variable (it is also recommended you add the following line in your rc file):
```
export PRISMS_PF_DIR=</absolute/path/to/PRISMS-PF/install>
```

Configure, compile, and install the main library

```
cmake -B build
cmake --build build -j <nprocs>
Expand All @@ -49,7 +58,7 @@ cmake --install build --prefix=$PRISMS_PF_DIR

Here `<nprocs>` denotes the number of threads you want to use to compile the library.

For access to our executable utilities, you should also add `bin` to path. You can also add this into your rc file to have permanent access to it.
For access to our executable utilities (recommended), you should also add `$PRISMS_PF_DIR/bin` to your path. You can have permanent access by adding the following line to your rc file
```
export PATH=$PATH:$PRISMS_PF_DIR/bin
```
Expand All @@ -62,7 +71,7 @@ cmake -DCMAKE_BUILD_TYPE=<type> -B build
cmake --build build -j <nprocs>
```

Here `<type>` is the build type. There are two options `Debug` and `Release`. `Release` contains more optimizations than `Debug`, but often has less meaningful error messages.
Here, `<type>` is the build type. There are two options: `Debug` and `Release`. `Release` contains more optimizations than `Debug` and typically offers much better performance, but `Debug` often provides more meaningful error messages.

Executables can be run in serial or parallel.
```
Expand All @@ -74,9 +83,9 @@ mpirun -n <nprocs> build/main

### Visualization

Outputs are most commonly visualized in the following open source applications:
Outputs are most commonly visualized in the following open-source applications:
- VisIt (https://visit-dav.github.io/visit-website/)
- Paraview (https://www.paraview.org/)
- ParaView (https://www.paraview.org/)

### Known Issues

Expand Down
Loading