Back to home page

EIC code displayed by LXR

 
 

    


Warning, /tutorial-setting-up-environment/learners/setup.md is written in an unsupported language. File is not indexed.

0001 ---
0002 title: Setup
0003 ---
0004 
0005 ::::::::::::::::::::::::::::::::::::::::::::: callout
0006 
0007 If you are using the [BNL SDCC](bnl-sdcc-quickstart.md) or the [JLab Farm](jlab-farm-quickstart.md),
0008 you may find the quick start info useful if you are new to these systems.
0009 
0010 :::::::::::::::::::::::::::::::::::::::::::::
0011 
0012 In advance of the training session, please ensure that
0013 
0014 1. You have a GitHub account ([sign up here](https://github.com/signup))
0015 2. You have singularity/apptainer or docker (on Mac) installed and working
0016    - 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
0017    - On your local system:
0018      - systems that use cvmfs or download images can install **singularity or apptainer** (see the [apptainer quick-start guide](https://apptainer.org/docs/user/main/quick_start.html))
0019      - systems that download images can install **docker** (see the [Docker website](https://www.docker.com/))
0020    - You should at a minimum be able to run either of the following commands and open a shell:
0021      - `singularity run docker://alpine`
0022      - `docker run --rm -it alpine`
0023 3. Download `eic-shell`:
0024    - Due to time and bandwidth limitations, this should be downloaded to your desired system before the live tutorial
0025    - From the system you use with singularity/apptainer or docker, make a folder called `eic`
0026    - From inside this directory:
0027      - Install by running the command:
0028 
0029        ```bash
0030        curl --location https://get.epic-eic.org | bash
0031        ```
0032 
0033      - **or** you can save the file at <https://get.epic-eic.org> as `install.sh` and run this script by hand:
0034 
0035        ```bash
0036        wget --output-document install.sh https://get.epic-eic.org
0037        bash install.sh
0038        ```
0039 
0040 If you have completed the numbered steps above, then you are ready for the tutorial. Additional
0041 information and training links are below:
0042 
0043 - Basic familiarity with Unix shell and Git
0044   - Software Carpentry [Unix Shell](https://swcarpentry.github.io/shell-novice/) training (recommended)
0045   - Software Carpentry [Basic Git](https://swcarpentry.github.io/git-novice/) training (recommended)
0046 - Basic familiarity with singularity and docker:
0047   - Software Carpentry [Incubator Singularity](https://carpentries-incubator.github.io/singularity-introduction/) training (optional)
0048   - HEP Software Foundation [Docker](https://hsf-training.github.io/hsf-training-docker/index.html) training (optional)