Skip to content
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.

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

Update Mbot instructions and hitchhiker's guide #6105

Merged
merged 2 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 17 additions & 13 deletions docs/Installation/InstallationOnClusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ want to load the modules, source the shell file for your system and run
## General Instructions

1. Run `export SPECTRE_HOME=/path/to/where/you/want/to/clone`
2. Clone SpECTRE using `git clone SPECTRE_URL $SPECTRE_HOME`
2. Clone SpECTRE using `git clone SPECTRE_URL $SPECTRE_HOME` where the
`SPECTRE_URL` is the GitHub url you want to use to clone the repo.
3. Run `cd $SPECTRE_HOME && mkdir build && cd build`
4. Run `. $SPECTRE_HOME/support/Environments/SYSTEM_TO_RUN_ON_gcc.sh`, where
`SYSTEM_TO_RUN_ON` is replaced by the name of the system as described in the
Expand Down Expand Up @@ -114,15 +115,18 @@ you do not need to install any dependencies, so you can skip steps 5 and 6.

## Mbot at Cornell

The only modules you need to load on `mbot` are `gcc/11.4.0 spectre-deps`. This
will load everything you need, including LLVM/Clang. You can source the
environment file by running `. $SPECTRE_HOME/support/Environments/mbot.sh` and
load the modules using `spectre_load_modules`. This
offers two functions, `spectre_run_cmake_gcc` and `spectre_run_cmake_clang` for
the different compilers. These both default to `Release` mode. If you are
developing code, please use either
`spectre_run_cmake_clang -D CMAKE_BUILD_TYPE=Debug` or
`spectre_run_cmake_clang -D SPECTRE_DEBUG=ON` (you can also use gcc). The second
command with `SPECTRE_DEBUG=ON` enables sanity checks and optimizations. This
means it can be used in production-level runs to ensure there aren't any subtle
bugs that might only arise after a decently long simulation.
Follow steps 1-3 of the general instructions.

The only modules you need to load on `mbot` are `gcc/11.4.0 spectre-deps`.
This will load everything you need, including LLVM/Clang. You
can source the environment file by running
`. $SPECTRE_HOME/support/Environments/mbot.sh` and load the modules using
`spectre_load_modules`. This offers two functions, `spectre_run_cmake_gcc`
and `spectre_run_cmake_clang` for the different compilers.
These both default to `Release` mode. If you are developing code, please use
either `spectre_run_cmake_clang -D CMAKE_BUILD_TYPE=Debug` or
`spectre_run_cmake_clang -D SPECTRE_DEBUG=ON` (you can also use gcc).
The second command with `SPECTRE_DEBUG=ON` enables sanity checks and
optimizations. This means it can be used in production-level runs to ensure
there aren't any subtle bugs that might only arise after a decently
long simulation.
19 changes: 16 additions & 3 deletions docs/Tutorials/BeginnersTutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,14 @@ command line right away:
spectre --help
```

If you are not in the container but instead on a desktop or cluster you can add
the bin directory to your path by `cd`ing to the build directory and running
```
export PATH=$PATH:`pwd`/bin
```
If you log out and log back in you will need to set this again, unless you add
it to your shell's init file.

## Running ExportCoordinates3D

First we will run the `ExportCoordinates3D` executable to visualize
Expand Down Expand Up @@ -196,9 +204,14 @@ the Paraview server, run
pvserver &
```

The `&` is so that the server runs in the background. If you hit `Enter` a
couple times you'll get back to being able to type commands. You should see some
output similar to
\note on compute clusters you should use the cluster-specific instructions for
using ParaView since you may require MPI and specifying which port to use. For
example, `mpirun -n 1 pvserver -p 11111` is likely more appropriate on a
cluster.

The `&` is so that the server runs in the background. If you hit `Enter`
a couple times you'll get back to being able to type commands. You should see
some output similar to

```
Waiting for client...
Expand Down
Loading