Skip to content

Commit

Permalink
Updated two pages to include a helpful WSL2 tip.
Browse files Browse the repository at this point in the history
  • Loading branch information
buddhasystem committed May 20, 2024
1 parent e4e05a4 commit 102ba17
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
23 changes: 17 additions & 6 deletions docs/_content/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ so make sure your computer is online at that time.
*In order to successfuly build eAST it is mandatory that you set the options listed below when using `cmake` to build Geant4*.
As you can see from the table, if you start from scratch you may need to install the prerequisits first such as
<em>X11, Qt5, OpenGL and Xerces-C++</em> libraries.
Please see the [Appendix](/content/installation.html#appendix-geant4-dependencies) for comments and some practical
Please see the [Appendix](/content/installation.html#appendix) for comments and some practical
advice about how to proceed.

<table border="1" width="60%">
Expand Down Expand Up @@ -147,15 +147,17 @@ path the the HepMC3 libraries. This can be done after sourcing the Geant4

---

## Appendix (GEANT4 dependencies)
## Appendix

### Xerces
### GEANT4 dependencies

#### Xerces

The [Xerces build and intallation webpage](https://xerces.apache.org/xerces-c/build-3.html#UNIXl){:target="_blank"}
mentions cmake -- although the latter is not explicitly invoked, and you only need to run `configure` and `make`.
Read the web page carefully.

### Qt
#### Qt

The Qt installation procedure has evolved over the years. Using the GUI installer
provided by the developer appears to frequently cause problems. At the time of writing,
Expand All @@ -168,13 +170,13 @@ sudo apt-get -y install build-essential openssl libssl-dev libssl1.0 libgl1-mesa
sudo apt-get install qtbase5-dev
sudo apt-get install qtdeclarative5-dev
```
### libxmu
#### libxmu

```bash
sudo apt-get install -y libxmu-dev
```

### Passing options to "make"
#### Passing options to "make"

On many Linux platforms, `cmake` is relying on `make` for the build step.
It is possible in these cases to pass helpful options (such as use multiple cores
Expand All @@ -184,4 +186,13 @@ for compilation) to `make` by setting an environment variable:
export MAKEFLAGS=-j4
```

### Running Geant4 graphics under WSL2

In some cases an extra step is needed to get the graphics driver to work correctly,
for example in WSL2 the following setting is helpful:

```bash
export LIBGL_ALWAYS_INDIRECT=
```


8 changes: 7 additions & 1 deletion docs/_content/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ name: manual
---


## Setting up the environemt
## Setting up the environment

* Source the Geant4 [post-installation script](https://geant4-userdoc.web.cern.ch/UsersGuides/InstallationGuide/html/postinstall.html){:target="_blank"}.
* Add the location of the _HepMC3_ libraries to the environment variable `LD_LIBRARY_PATH`
Expand All @@ -29,6 +29,12 @@ export LD_LIBRARY_PATH=/opt/hepmc3/lib:$LD_LIBRARY_PATH
export PATH=/opt/east/bin/:$PATH
```

When using WSL2 and requiring graphics capability in Geant4, the following setting
helps to get the graphcis working correctly:
```bash
export LIBGL_ALWAYS_INDIRECT=
```

## Starting eAST

*eAST* runs both in batch mode and interactive mode. To run it in batch mode, execute the application with a macro file,
Expand Down

0 comments on commit 102ba17

Please sign in to comment.