From 171b747e9bf3bc352f283635078cd8a34f08dbdc Mon Sep 17 00:00:00 2001 From: Sylvester Joosten <sjoosten@anl.gov> Date: Fri, 21 May 2021 02:49:16 -0500 Subject: [PATCH] Edited quickstart --- src/docs/getting-started/quickstart.mdx | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/docs/getting-started/quickstart.mdx b/src/docs/getting-started/quickstart.mdx index b062bcf..c7e91a8 100644 --- a/src/docs/getting-started/quickstart.mdx +++ b/src/docs/getting-started/quickstart.mdx @@ -5,7 +5,7 @@ title: "Quick-start Guide" ## Prerequisites -The programmer is assumed to be familiar with +We assume that you are somewhat familiar with: - git and gitlab (https://eicweb.phy.anl.gov) - working in the terminal over ssh - cmake, C++, python, and shell scripting @@ -15,8 +15,11 @@ This tutorial requires that [singularity](singularity) is installed on the local system. Singularity can be [downloaded here](https://sylabs.io/guides/3.7/user-guide/quick_start.html) -- 3.7 being the most recent version as of January 2021. + +*For an optimal experience, we strongly recommend you to use singularity 3 or later for this tutorial. +Use (very) old versions of singularity (e.g. 2.6.x) at your own risk!* -## The EIC Software Container +## The EIC Software Container (jug_xl) ### Step 1: Create a local directory that you want to work in, e.g., `~/eic` ```bash @@ -24,9 +27,9 @@ mkdir ~/eic cd ~/eic ``` -### Step 2: Deploy the containerized environment and launc a shell +### Step 2: Deploy the containerized environment and launch a shell -Execute the following line in your tgerminal to setup your environment in your sandbox +Execute the following line in your terminal to setup your environment in your sandbox directory. This will install the latest stable container and place a script called `eic-shell` in the top-level directory. This script will load the environment for you. @@ -61,12 +64,16 @@ Before moving on to part 1, let's generate the geometry in a root file: ```bash cd athena +source /opt/detector/setup.sh dd_web_display --export athena.xml ``` This will generate the file `detector_geometry.root`, which you should copy to your local machine. Then open the [web viewer](https://eic.phy.anl.gov/geoviewer/), click on the `...` and open the local root file. +(Note, the `source /opt/detector/setup.sh` command adds the Athena detector plugins that ship +with the jug_xl container to your environment.) + Or if you want to skip this just [click here to view the latest detector](https://eic.phy.anl.gov/geoviewer/index.htm?file=https://eicweb.phy.anl.gov/api/v4/projects/473/jobs/artifacts/master/raw/geo/detector_geo_full.root?job=report&item=default;1&opt=clipxyz;transp30;zoom75;ROTY290;ROTZ350;trz0;trr0;ctrl;all&). -- GitLab