Skip to content

Commit 3e3e4ab

Browse files
authored
doc: jug_xl -> eic_xl (#1620)
### Briefly, what does this PR introduce? This PR updates documentation to refer consistently to `eic_xl` as the container image to use. ### What kind of change does this PR introduce? - [ ] Bug fix (issue #__) - [ ] New feature (issue #__) - [x] Documentation update - [ ] Other: __ ### Please check if this PR fulfills the following: - [ ] Tests for the changes have been added - [x] Documentation has been added / updated - [ ] Changes have been communicated to collaborators ### Does this PR introduce breaking changes? What changes might users need to make to their code? No. ### Does this PR change default behavior? No.
1 parent 92b2f5a commit 3e3e4ab

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/howto/use_docker.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The containers are released both for docker and singularity. Singularity images
88
- [Docker Hub](https://hub.docker.com/u/eicweb)
99
- CVMFS path (available at BNL and JLab):
1010
```
11-
singularity run /cvmfs/singularity.opensciencegrid.org/eicweb/jug_xl:nightly
11+
singularity run /cvmfs/singularity.opensciencegrid.org/eicweb/eic_xl:nightly
1212
```
1313

1414
### Images structure:
@@ -19,7 +19,7 @@ The containers are released both for docker and singularity. Singularity images
1919

2020
- **debian_base** - is a container generic base container based on amd64/debian:testing
2121
- **jug_dev** - have all major HENP packages such as ROOT, Geant4 and DD4HEP but without detector and reconstruction. The image is used for testing purposes and automation.
22-
- **jug_xl** - intended to be used to run simulation and work on detectors for users. jug_dev + full simulation packages
22+
- **eic_xl** - intended to be used to run simulation and work on detectors for users. jug_dev + full simulation packages
2323

2424

2525

@@ -39,7 +39,7 @@ So testing is the precursor to the next release version.
3939

4040
**TL;DR;**
4141

42-
Now it is recommended to use: ```eicweb/jug_xl:nightly```
42+
Now it is recommended to use: ```eicweb/eic_xl:nightly```
4343

4444

4545
## Run in docker
@@ -50,13 +50,13 @@ Containers are available at eicweb namespace at
5050
To download or update the container:
5151

5252
```bash
53-
docker pull eicweb/jug_xl:nightly
53+
docker pull eicweb/eic_xl:nightly
5454
```
5555

5656
Running docker (minimal and probably useless):
5757

5858
```bash
59-
docker run -it --rm eicweb/jug_xl:nightly
59+
docker run -it --rm eicweb/eic_xl:nightly
6060
```
6161

6262

@@ -113,7 +113,7 @@ You can bind any directory on your system to docker image by using **-v** flag:
113113
Convenient place inside docker image is `/mnt/` directory. Full example:
114114

115115
```bash
116-
docker run -it -v /home/user/eic/data:/mnt/data --rm eicweb/jug_xl:nightly
116+
docker run -it -v /home/user/eic/data:/mnt/data --rm eicweb/eic_xl:nightly
117117
ls /mnt/data
118118
```
119119

@@ -133,7 +133,7 @@ ls /mnt/data
133133
With debugging enabled and all ports open:
134134

135135
```
136-
docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined eicweb/jug_xl:nightly
136+
docker run -it --rm --cap-add=SYS_PTRACE --security-opt seccomp=unconfined eicweb/eic_xl:nightly
137137
```
138138

139139

@@ -146,7 +146,7 @@ The setup depends on particular tool:
146146
- [Visual Studio Code docker remote debugging](https://code.visualstudio.com/docs/remote/remote-overview)
147147
- [CLion docker toolchain](https://www.jetbrains.com/help/clion/clion-toolchains-in-docker.html)
148148

149-
> Use `\usr\local\bin\cmake` as cmake path, when configuring IDEs with jug_xl image
149+
> Use `\usr\local\bin\cmake` as cmake path, when configuring IDEs with eic_xl image
150150
151151
![vscode-docker](vscode_docker.png ':size=800')
152152

@@ -166,7 +166,7 @@ You can use X11 natively (as natively as possible) with this docker image in you
166166
To use graphics, make sure you are in an X11 session and run the following command:
167167

168168
```bash
169-
docker run -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --rm -it --user $(id -u) eicweb/jug_xl:nightly
169+
docker run -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --rm -it --user $(id -u) eicweb/eic_xl:nightly
170170
```
171171

172172
There might be issues with user id on systems like JLab farms.
@@ -179,7 +179,7 @@ Make sure VcXsrv is whitelisted in the Windows firewall when prompted.
179179
Start VcXsrv with 'allow from any origin' flag
180180

181181
```bash
182-
docker run --rm -it -e LIBGL_ALWAIS_INDIRECT=1 -e DISPLAY=10.0.75.1:0 eicweb/jug_xl:nightly
182+
docker run --rm -it -e LIBGL_ALWAIS_INDIRECT=1 -e DISPLAY=10.0.75.1:0 eicweb/eic_xl:nightly
183183
```
184184

185185
> 10.0.75.1 address corresponds to the network configuration in docker settings
@@ -208,7 +208,7 @@ This will start XQuartz and whitelist your local IP address.
208208
Finally, you can start up docker with the following command:
209209

210210
```
211-
docker run --rm -it -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$ip:0 eicweb/jug_xl:nightly
211+
docker run --rm -it -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$ip:0 eicweb/eic_xl:nightly
212212
```
213213

214214

@@ -221,7 +221,7 @@ action needed. For the most optimal experience, you can install your software to
221221
``/usr/local`` is a symlink to ``/opt/view``).
222222

223223
```
224-
FROM eicweb/jug_xl:nightly
224+
FROM eicweb/eic_xl:nightly
225225
RUN apt-get update \
226226
&& export DEBIAN_FRONTEND=noninteractive \
227227
&& apt-get -y install git gdb

docs/howto/use_singularity.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ For farms like at BNL or JLab the images are automatically replicated to
8888
CVMS:
8989

9090
```bash
91-
/cvmfs/singularity.opensciencegrid.org/eicweb/jug_xl*
91+
/cvmfs/singularity.opensciencegrid.org/eicweb/eic_xl*
9292

9393
# example to run
94-
singularity run /cvmfs/singularity.opensciencegrid.org/eicweb/jug_xl:nightly
94+
singularity run /cvmfs/singularity.opensciencegrid.org/eicweb/eic_xl:nightly
9595
```
9696

9797
### eic-shell explained
@@ -106,7 +106,7 @@ singularity like:
106106
# $PREFIX here is where you installed everything (by default where install.sh executed)
107107
export EIC_SHELL_PREFIX=...
108108
export SINGULARITY_BINDPATH=/home
109-
singularity exec $PREFIX/local/lib/jug_xl-nightly.sif eic-shell $@
109+
singularity exec $PREFIX/local/lib/eic_xl-nightly.sif eic-shell $@
110110
```
111111

112112
The **eic-shell** inside the container loads the proper environment and

docs/tutorial/02-work-environment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ curl --location https://get.epic-eic.org | bash
2424
# or, if /cvmfs is available:
2525
# n.b. on JLab ifarm you may need to do 'module load singularity/3.9.5' first
2626

27-
singularity exec /cvmfs/singularity.opensciencegrid.org/eicweb/jug_xl:nightly eic-shell
27+
singularity exec /cvmfs/singularity.opensciencegrid.org/eicweb/eic_xl:nightly eic-shell
2828

2929
```
3030
Once inside the eic-shell, you should source the geometry setup script since this is not done by default.

0 commit comments

Comments
 (0)