README.md 1.26 KB
Newer Older
David Blyth's avatar
David Blyth committed
1 2 3 4
# About
This repository contains a Dockerfile for building a base container image for a
variety of uses in the context of EIC studies at ANL.

5 6 7 8
## Partial software list
* CLHEP
* DD4hep
* GEANT4
9
* GenFit
10
* LCIO
David Blyth's avatar
David Blyth committed
11
* ProIO
12 13 14
* Protobuf
* ROOT

David Blyth's avatar
David Blyth committed
15 16
# Using the image
## Docker
17
Example:
David Blyth's avatar
David Blyth committed
18 19 20
```shell
docker run -it argonneeic/base
```
21 22 23
See [Docker
documentation](https://docs.docker.com/engine/reference/commandline/cli/) for
more command line options.
David Blyth's avatar
David Blyth committed
24 25

## Singularity
26 27 28 29
Singularity v2.3+ is recommended.  If compactness of the image is a priority,
use v2.4+.

Example:
David Blyth's avatar
David Blyth committed
30 31 32 33
```shell
singularity pull docker://argonneeic/base
./base.img
```
34 35 36 37 38 39 40 41 42 43
Please see [the singularity
documentation](http://singularity.lbl.gov/quickstart) for more information.

In the above scenario, by default the user's `.bashrc` file will be executed
upon starting the container.  This can cause problems in some cases.  If it
seems that the environment is being negatively affected by the user's
`.bashrc`, one may avoid executing the script like so:
```shell
singularity exec base.img bash --norc
```
David Blyth's avatar
David Blyth committed
44 45 46 47

# Building the image
Example:
```shell
48
docker build -t baseimg --build-arg BUILD_THREADS=5 https://eicweb.phy.anl.gov/EIC/BaseImage.git
David Blyth's avatar
David Blyth committed
49
```
David Blyth's avatar
David Blyth committed
50 51

# Contact
David Blyth's avatar
David Blyth committed
52
For additional information, contact the maintainer [David Blyth](mailto:dblyth@anl.gov)