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