Summary and Setup

Welcome to the EIC Tutorial on setting up your environment!

This is typically the first tutorial in the series of EIC tutorials. It will help you set up your environment to be productive in the EIC community. Once your environment is working, good next steps are the Analysis tutorial and the File Access tutorial.

Prerequisite

Prerequisites

Please take a look at the Setup page for necessary prerequisites for this lesson.

Callout

If you are using the BNL SDCC or the JLab Farm, you may find the quick start info useful if you are new to these systems.

In advance of the training session, please ensure that

1. You have a GitHub account (sign up here)
2. You have singularity/apptainer or docker (on Mac) installed and working
   • Provided by default on BNL SDCC and the JLab iFarm, check by trying the command singularity and verify that you get an info dump on the usage of the command
   • On your local system:
     • systems that use cvmfs or download images can install singularity or apptainer (see the apptainer quick-start guide)
     • systems that download images can install docker (see the Docker website)
   • You should at a minimum be able to run either of the following commands and open a shell:
     • singularity run docker://alpine
     • docker run --rm -it alpine
3. Download eic-shell:
   • Due to time and bandwidth limitations, this should be downloaded to your desired system before the live tutorial
   • From the system you use with singularity/apptainer or docker, make a folder called eic
   • From inside this directory:

     • Install by running the command:

       BASH

       curl --location https://get.epic-eic.org | bash

     • or you can save the file at https://get.epic-eic.org as install.sh and run this script by hand:

       BASH

       wget --output-document install.sh https://get.epic-eic.org
       bash install.sh

If you have completed the numbered steps above, then you are ready for the tutorial. Additional information and training links are below:

• Basic familiarity with Unix shell and Git
  • Software Carpentry Unix Shell training (recommended)
  • Software Carpentry Basic Git training (recommended)
• Basic familiarity with singularity and docker:
  • Software Carpentry Incubator Singularity training (optional)
  • HEP Software Foundation Docker training (optional)