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

David Blyth's avatar
David Blyth committed
5
## Key software packages
David Blyth's avatar
David Blyth committed
6
* ProIO
7 8
* ROOT

David Blyth's avatar
David Blyth committed
9
# Running a container
David Blyth's avatar
David Blyth committed
10
## Docker
11
Example:
David Blyth's avatar
David Blyth committed
12 13 14
```shell
docker run -it argonneeic/base
```
15 16 17
See [Docker
documentation](https://docs.docker.com/engine/reference/commandline/cli/) for
more command line options.
David Blyth's avatar
David Blyth committed
18 19

## Singularity
20 21 22 23
Singularity v2.3+ is recommended.  If compactness of the image is a priority,
use v2.4+.

Example:
David Blyth's avatar
David Blyth committed
24 25 26 27
```shell
singularity pull docker://argonneeic/base
./base.img
```
28 29 30 31 32 33 34 35 36 37
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
38

David Blyth's avatar
David Blyth committed
39 40 41 42 43 44
# Using the container
The main functionality that this container image provides is the ability to
read and write files that are used in the simulation and reconstruction cycle.
For this purpose, the image includes ProIO (all languages) and ROOT.  Try
commands like `proio-ls` or `root`.

David Blyth's avatar
David Blyth committed
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)