diff --git a/src/docs/getting-started/quickstart.mdx b/src/docs/getting-started/quickstart.mdx index 9d96055fab7f42bf47639cc91346429c00f8001c..25b480c7d74ecb8a1e4a8c597e0a8656627108c3 100644 --- a/src/docs/getting-started/quickstart.mdx +++ b/src/docs/getting-started/quickstart.mdx @@ -6,10 +6,9 @@ title: "Quick-start Guide" ## Prerequisites The programmer is assumed to be familiar with +- git and gitlab (https://eicweb.phy.anl.gov) - working in the terminal over ssh -- `git` and gitlab (https://eicweb.phy.anl.gov) -- using `cmake` -- C++, python, and shell scripting +- cmake, C++, python, and shell scripting This tutorial requires that [singularity](singularity) is installed @@ -45,19 +44,36 @@ Now you can launch a shell in our development environment: ## Step 3: Clone the repos -Right now there are 3 repos you need: -* Tutorial files +There are 2 repos you need: * IP6 (IP-specific components) * Athena detector ```bash -git clone https://eicweb.phy.anl.gov/EIC/tutorials/ip6_tutorial_1.git git clone https://eicweb.phy.anl.gov/EIC/detectors/athena.git git clone https://eicweb.phy.anl.gov/EIC/detectors/ip6.git +ln -s ../ip6/ip6 athena/ip6 ``` -Initially we will just be using the first repo. So we will com back to the latter two later on. +In part 1 of the tutorial we will be mostly using files from a tutorial repo. +Later on, we will com back to these detector repositories. +## Step 4: Looking at the geometry + +Before moving on to part 1, let's generate the geometry in a root file: + + +``` +cd athena +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. + +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&). + + +In your browser diff --git a/src/docs/part1/simple_detector.md b/src/docs/part1/simple_detector.md index 1c41dec63f7d76a94ff5970d3051269d860db753..b8f8e34af1370f52825aae0468094b11f11bb45d 100644 --- a/src/docs/part1/simple_detector.md +++ b/src/docs/part1/simple_detector.md @@ -72,12 +72,4 @@ root -b -q example_cell_size.cxx+ ```  -```bash -cd ../.. -mkdir NPDet/build && cd NPDet/build -cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/development -make -j4 install -cd ../examples -print_materials gem_tracker_disc.xml 0 0 0 100 0 100 -```