diff --git a/src/docs/getting-started/modulefiles.md b/src/docs/getting-started/modulefiles.md index ecc8e0e904a8fa6c5c2951607a08fd9004104bea..5056155847bf61e04326e659c23384d4fab8221d 100644 --- a/src/docs/getting-started/modulefiles.md +++ b/src/docs/getting-started/modulefiles.md @@ -21,4 +21,28 @@ https://modules.readthedocs.io/en/latest/ +## Development within singularity container + +[See here](singularity) for more info on singularity. + +The following helper runs bash inside `eic_container` +```bash +module load eic_container +container_dev +``` + +For projects that you want to build but which are also inside of the container, +you must make sure to set `$PATH` and `$LD_LIBRARY_PATH` to point to the +development build's installation prefix first. Here we assume your development +builds are being installed into `$HOME/stow/development` + +A simple setup script will make sure things are in order +```shell title=setup.sh +module use $HOME/etc/modulefiles +module load eic_container +export PATH=$HOME/stow/development/bin:$PATH +export LD_LIBRARY_PATH=$HOME/stow/development/lib:$HOME/stow/development/lib64:$LD_LIBRARY_PATH +export ROOT_INCLUDE_PATH=$HOME/stow/development/include:$ROOT_INCLUDE_PATH +``` + diff --git a/src/docs/getting-started/quickstart.mdx b/src/docs/getting-started/quickstart.mdx index 2859974f7ef51d9b7803bbab0e5cf7dd0e2ecc7a..9d96055fab7f42bf47639cc91346429c00f8001c 100644 --- a/src/docs/getting-started/quickstart.mdx +++ b/src/docs/getting-started/quickstart.mdx @@ -22,7 +22,7 @@ most recent version as of January 2021. ## The EIC Software Container -### Create a local directory that you want to work in, e.g., `~/eic` +### Step 1: Create a local directory that you want to work in, e.g., `~/eic` ```bash mkdir ~/eic cd ~/eic @@ -38,83 +38,27 @@ directory. This will install the latest stable container and place a script call 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. - -Installing the [eic_container](quickstart/eic_container) is done with the -following: - -```shell -git clone https://eicweb.phy.anl.gov/containers/eic_container.git -``` - -From here follow the instructions in the README file. Those will faithfully -install the container, and then follow the instructions below. - -Inspect the list of files installed, noting the locations of modulefiles and -wrapper scripts. - - -## Using the container - +Now you can launch a shell in our development environment: ```bash -module use $HOME/etc/modulefiles -module load eic_container +./eic-shell ``` -[See modulefiles](modulefiles) for more info. - -[Also see environment](environment) for more info. +## Step 3: Clone the repos +Right now there are 3 repos you need: +* Tutorial files +* IP6 (IP-specific components) +* Athena detector -## Development within singularity container - -[See here](singularity) for more info on singularity. - -The following helper runs bash inside `eic_container` ```bash -module load eic_container -container_dev +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 ``` -For projects that you want to build but which are also inside of the container, -you must make sure to set `$PATH` and `$LD_LIBRARY_PATH` to point to the -development build's installation prefix first. Here we assume your development -builds are being installed into `$HOME/stow/development` - -A simple setup script will make sure things are in order -```shell title=setup.sh -module use $HOME/etc/modulefiles -module load eic_container -export PATH=$HOME/stow/development/bin:$PATH -export LD_LIBRARY_PATH=$HOME/stow/development/lib:$HOME/stow/development/lib64:$LD_LIBRARY_PATH -export ROOT_INCLUDE_PATH=$HOME/stow/development/include:$ROOT_INCLUDE_PATH -``` - -## Detector Library - -The +Initially we will just be using the first repo. So we will com back to the latter two later on. -```bash -source setup.sh -module load eic_container -git clone https://eicweb.phy.anl.gov/EIC/NPDet.git -cd NPDet/examples -print_materials gem_tracker_disc.xml 0 0 0 100 0 100 -``` - -The last line dumps the materials encounter along a line defined by two points. -```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 -``` diff --git a/src/docs/part1/simple_detector.md b/src/docs/part1/simple_detector.md index b8f8e34af1370f52825aae0468094b11f11bb45d..1c41dec63f7d76a94ff5970d3051269d860db753 100644 --- a/src/docs/part1/simple_detector.md +++ b/src/docs/part1/simple_detector.md @@ -72,4 +72,12 @@ 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 +```