Warning, /tutorial-geometry-development-using-dd4hep/learners/setup.md is written in an unsupported language. File is not indexed.
0001 ---
0002 title: Setup
0003 ---
0004
0005 In advance of the training session, please ensure that
0006
0007 1. You have a GitHub account ([sign up here](https://github.com/signup))
0008 1. Your GitHub account is a member of the [EIC organization](https://github.com/eic) on GitHub
0009 - Email [the EIC software conveners](mailto:eic-software-l-request@lists.bnl.gov) with your GitHub account to be added
0010 1. You have singularity/apptainer or docker (on Mac) installed and working
0011 - `module load singularity` (on most JLab or BNL systems) (preferred option)
0012 - Local system options:
0013 - 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))
0014 - systems that download images can install **docker** (see the [Docker website](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, install by running the command:
0022
0023 ```bash
0024 curl --location https://get.epic-eic.org | bash
0025 ```
0026
0027 - **or** you can save the file at [https://get.epic-eic.org](https://get.epic-eic.org) as `install.sh` and run this script by hand:
0028
0029 ```bash
0030 wget --output-document install.sh https://get.epic-eic.org
0031 bash install.sh
0032 ```
0033
0034 If you have completed the numbered steps above, then you are ready for the tutorial. Additional
0035 information and training links are below:
0036
0037 - Basic familiarity with Unix shell and Git
0038 - Software Carpentry [Unix Shell](https://swcarpentry.github.io/shell-novice/) training (recommended)
0039 - Software Carpentry [Basic Git](https://swcarpentry.github.io/git-novice/) training (recommended)
0040 - Basic familiarity with singularity and docker:
0041 - Software Carpentry [Incubator Singularity](https://carpentries-incubator.github.io/singularity-introduction/) training (optional)
0042 - HEP Software Foundation [Docker](https://hsf-training.github.io/hsf-training-docker/index.html) training (optional)
