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