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. Your GitHub account is a member of the [EIC organization](https://github.com/eic) on GitHub
0011 - Email [the EIC software conveners](mailto:eic-software-l-request@lists.bnl.gov) with your GitHub account to be added
0012 1. You have singularity/apptainer or docker (on Mac) installed and working
0013 - `module load singularity` (on JLab iFarm)
0014 - Provided by default on BNL SDCC, no need to do module load!
0015 - On your local system:
0016 - systems that use cvmfs or download images can install **singularity or apptainer** (see [here](https://apptainer.org/docs/user/main/quick_start.html))
0017 - systems that download images can install **docker** (see [here](https://www.docker.com/))
0018 - You should at a minimum be able to run either of the following commands and open a shell:
0019 - `singularity run docker://alpine`
0020 - `docker run --rm -it alpine`
0021 1. Download `eic-shell`:
0022 - Due to time and bandwidth limitations, this should be downloaded to your desired system before the live tutorial
0023 - From the system you use with singularity/apptainer or docker, make a folder called `eic`
0024 - From inside this directory:
0025 - Install by running the command:
0026 ```
0027 curl --location https://get.epic-eic.org | bash
0028 ```
0029 - **or** you can save the file at https://get.epic-eic.org as `install.sh` and run this script by hand:
0030 ```
0031 wget --output-document install.sh https://get.epic-eic.org
0032 bash install.sh
0033 ```
0034
0035 If you have completed the numbered steps above, then you are ready for the tutorial. Additional information and training links are below:
0036 - Basic familiarity with Unix shell and Git
0037 - Software Carpentry [Unix Shell](https://swcarpentry.github.io/shell-novice/) training (recommended)
0038 - Software Carpentry [Basic Git](https://swcarpentry.github.io/git-novice/) training (recommended)
0039 - Basic familiarity with singularity and docker:
0040 - Software Carpentry [Incubator Singularity](https://carpentries-incubator.github.io/singularity-introduction/) training (optional)
0041 - HEP Software Foundation [Docker](https://hsf-training.github.io/hsf-training-docker/index.html) training (optional)
0042
0043 {% include links.md %}
