From a5203f14f94b7b2aa9ecb57a7f911357134242a3 Mon Sep 17 00:00:00 2001 From: Whitney Armstrong <warmstrong@anl.gov> Date: Thu, 20 May 2021 18:27:19 -0500 Subject: [PATCH] modified: getting-started/quickstart.mdx modified: overview.md --- src/docs/getting-started/quickstart.mdx | 26 ++++++++++++++++++++----- src/docs/overview.md | 10 ++++++---- 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/src/docs/getting-started/quickstart.mdx b/src/docs/getting-started/quickstart.mdx index e7e61f3..2859974 100644 --- a/src/docs/getting-started/quickstart.mdx +++ b/src/docs/getting-started/quickstart.mdx @@ -12,18 +12,34 @@ The programmer is assumed to be familiar with - C++, python, and shell scripting -Create an account on https://eicweb.phy.anl.gov and configure your account. - This tutorial requires that [singularity](singularity) is installed -on the system. We also assumes [modulefiles](modulefiles) can be -used but are not required. - +on the local system. Singularity can be downloaded by going to https://sylabs.io/guides/3.7/user-guide/quick_start.html , with 3.7 being the most recent version as of January 2021. ## The EIC Software Container + + +### Create a local directory that you want to work in, e.g., `~/eic` +```bash +mkdir ~/eic +cd ~/eic +``` + +### Step 2: Deploy the containerized environment and launc a shell + +Execute the following line in your tgerminal 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. + +```bash +curl https://eicweb.phy.anl.gov/containers/eic_container/-/raw/master/install.sh | bash +``` + + + To properly emulate the EIC enviornmant a container containing necessary software is needed. diff --git a/src/docs/overview.md b/src/docs/overview.md index ed8c81a..2161a2c 100644 --- a/src/docs/overview.md +++ b/src/docs/overview.md @@ -30,11 +30,13 @@ The idea is to use plain-old-datatype IO. PODIO stamps out structs based on yaml ## NPDet - Nuclear physics detector library -As we will learn the compact detector description files are used to build detectors from a parameterized detector library. -NPDet is a collection of _generic detectors_ and _concept detectors_. - -In a hack-a-thon we will add to this detector library. +NPDet is a collection of _generic detectors_ and _geometry tools_ built around using DD4hep. + - `dd_web_display` + - `npdet_info` + - `npdet_to_step` + - `npdet_to_teve` + - `npdet_fields` ## Reconstruction and Tracking Tools -- GitLab