quickstart.mdx

---
title: "Quick-start Guide"
---


## Prerequisites

The programmer is assumed to be familiar with
- working in the terminal over ssh
- `git` and gitlab (https://eicweb.phy.anl.gov)
- using `cmake`
- C++, python, and shell scripting


This tutorial requires that [singularity](singularity) is installed 
on the local system. 
Singularity can be downloaded by going to
https://sylabs.io/guides/3.7/user-guide/quick_start.html , with 3.7 being the 
most recent version as of January 2021.
 

## The EIC Software Container


### Step 1: Create a local directory that you want to work in, e.g., `~/eic`
```bash
mkdir ~/eic
cd ~/eic
```

### Step 2: Deploy the containerized environment and launc a shell

Execute the following line in your tgerminal to setup your environment in your sandbox
directory. This will install the latest stable container and place a script called
`eic-shell` in the top-level directory. This script will load the environment for you.

```bash
curl https://eicweb.phy.anl.gov/containers/eic_container/-/raw/master/install.sh | bash
```

Now you can launch a shell in our development environment:
```bash
./eic-shell
```

## Step 3: Clone the repos

Right now there are 3 repos you need:
* Tutorial files
* IP6 (IP-specific components)
* Athena detector

```bash
git clone https://eicweb.phy.anl.gov/EIC/tutorials/ip6_tutorial_1.git
git clone https://eicweb.phy.anl.gov/EIC/detectors/athena.git
git clone https://eicweb.phy.anl.gov/EIC/detectors/ip6.git
```

Initially we will just be using the first repo. So we will com back to the latter two later on.