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

HPC documentation #349

Merged
merged 7 commits into from
Nov 10, 2023
Merged
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
19 changes: 19 additions & 0 deletions doc/user_guide/Singularity.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,22 @@ If you wish to read further about Singularity, you can find a substantial amount
singularity home website: https://sylabs.io/guides/3.5/user-guide/introduction.html. Including many tutorials and more
complex use cases.


## Exporting visualisations on HPC's
By default, BioDynaMo uses ParaView for visualization, which needs an X-display server to function. Since the Singularity image does not provide a graphical desktop environment and hence no X-server, there are two workarounds.

### Option 1: Using xvfb
```xvfb``` stands for X virtual frame buffer and emulates the required display server. Start a virtual frame buffer with:
```
/biodynamo/util/xvfb-initd.sh start
```
The buffer can be managed with the arguments ```start```|```stop```|```restart```

Note: Some systems may require display forwarding **before** starting the frame buffer. This can be achived through ```export DISPLAY=0```.

### Option 2: Setting Paraview to work in a headless mode using the CMAKE flag
Paraview with the osmesa or EGL backend does not require an X-server. To change the backend, you have to edit the cmake options in [1], build paraview, and replace the ParaView version that BioDynaMo installs. See also [2].

[1] https://github.com/BioDynaMo/biodynamo/blob/HPC-documentation/util/build-third-party/paraview/build.sh

[2] https://discourse.paraview.org/t/pvpython-offscreen-rendering-segfault/246/3
Loading