Skip to content
Snippets Groups Projects
Commit a661f7ad authored by Whitney Armstrong's avatar Whitney Armstrong
Browse files

modified: ../config/sidebar.yml

	modified:   getting-started/eic_container.md
	modified:   getting-started/environment.md
	deleted:    getting-started/quickstart.md
	new file:   getting-started/quickstart.mdx
	modified:   hackathon.md
	modified:   index.mdx
	new file:   links.md
	new file:   ../../static/Argonne_color_black_transparent.png
	new file:   ../../static/Argonne_color_white_transparent.png
	modified:   ../../static/banner.png
	new file:   ../../static/favicon.ico
	modified:   ../../static/favicon.png
parent 10ffd82d
No related branches found
No related tags found
No related merge requests found
...@@ -2,22 +2,28 @@ ...@@ -2,22 +2,28 @@
- label: 'Home' - label: 'Home'
link: '/' link: '/'
- label: 'Introduction' - label: 'Getting started'
link: '/introduction'
- label: 'Getting really started'
items: items:
- label: 'Quick-start ' - label: 'Quick-start '
link: '/getting-started/quickstart' link: '/getting-started/quickstart'
- label: 'Modulefiles ' # - label: 'Modulefiles '
link: '/getting-started/modulefiles' # link: '/getting-started/modulefiles'
- label: 'Singularity' # - label: 'Singularity'
link: '/getting-started/singularity' # link: '/getting-started/singularity'
- label: 'EIC container' # - label: 'EIC container'
link: '/getting-started/eic_container' # link: '/getting-started/eic_container'
- label: 'Environment' # - label: 'Environment'
link: '/getting-started/environment' # link: '/getting-started/environment'
- label: 'Part 1' - label: Tutorials
items: items:
- label: 'Part 1: Simple Detectors'
link: '/part1/simple_detector'
- label: 'Part 2: Adding Detectors'
link: '/part2/simple_detector'
- label: References
items:
- label: 'Links'
link: '/links'
- label: Usage - label: Usage
items: items:
- label: 'doc Getting started' - label: 'doc Getting started'
......
...@@ -16,3 +16,9 @@ cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eic_container_1.0.0 ...@@ -16,3 +16,9 @@ cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eic_container_1.0.0
make -j4 install make -j4 install
``` ```
## Using the container
```bash
module load eic_container
```
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
title: "Development Environment" title: "Development Environment"
--- ---
## Development within singularity ## Development within singularity container
The following helper runs bash inside `eic_container` The following helper runs bash inside `eic_container`
```bash ```bash
......
---
title: "Quick start"
metaTitle: "Quickstart"
metaDescription: "Getting up and running quickly"
---
# Prerequisites
The programmer should already be familiar with
- working in the terminal over ssh
- git and gitlab
- using `cmake`
- C++, python, and shell scripting
[modulefiles](quickstart/1-modulefiles)
[singularity](quickstart/2-singularity)
[eic_container](quickstart/3-eic_container)
# Clone Tutorial Repository
# Environment
---
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
Create an account on https://eicweb.phy.anl.gov and configure your account.
This tutorial requires that [singularity](singularity) is installed
on the system. We also assumes [modulefiles](modulefiles) can be
used but are not required.
## The EIC Software Container
Installing the [eic_container](quickstart/eic_container) is done with the
following:
```shell
git clone https://eicweb.phy.anl.gov/containers/eic_container.git
mkdir eic_container/build
cd eic_container/build
cmake ../. -DCMAKE_INSTALL_PREFIX=$HOME/stow/eic_container_1.0.2
make -j4 install
```
Inspect the list of files installed, noting the locations of modulefiles and
wrapper scripts.
## Using the container
```bash
module load eic_container
```
## Development within singularity container
The following helper runs bash inside `eic_container`
```bash
module load eic_container
container_dev
```
For projects that you want to build but which are also inside of the container,
you must make sure to set `$PATH` and `$LD_LIBRARY_PATH` to point to the
development build's installation prefix first. Here we assume your development
builds are being installed into `$HOME/stow/development`
A simple setup script will make sure
```bash
export $PATH=$HOME/stow/development/bin:$PATH
export $LD_LIBRARY_PATH=$HOME/stow/development/lib:$HOME/stow/development/lib64:$LD_LIBRARY_PATH
export $ROOT_INCLUDE_PATH=$HOME/stow/development/include:$ROOT_INCLUDE_PATH
```
...@@ -2,6 +2,23 @@ ...@@ -2,6 +2,23 @@
title: "Simulation Hackathon " title: "Simulation Hackathon "
--- ---
# Goals ## Tasks
### EIC
1. Beam pipe and beamline final focusing quads (FFQ)
2. Roman pot detectors placed with a quad and dipole in between the IR and detectors.
3. RICH material (no optical photons) and simple digitization.
4. ACTS integration
5. CLEO magnet field map
6.
### SoLID
1. Update magnet geometry (10 ft from end of magnet to calorimeter). See J. Benesch doc.
2. Gas cherenkov materials.
...@@ -2,16 +2,24 @@ ...@@ -2,16 +2,24 @@
title: "EIC Software" title: "EIC Software"
--- ---
import Background from './background.md'
## Introduction
This tutorial is meant to prepare you to contribute to the simulation toolkit for the EIC.
The tutorial is not meant to represent a complete software toolkit, but to put together enough pieces
together to get some results and serve as a jumping off point for further development.
## Tutorials ## Tutorials
- [Quick start](quickstart.md) - Start here to download software and configure your development environment. - [Quick start](getting-started/quickstart) - Start here to download software and configure your development environment.
- [Part 1](part1.md) - An introduction to the detector description starting with a simple detector. - [Part 1](part1.md) - An introduction to the detector description starting with a simple detector.
This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet). This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet).
- [Part 2](part2.md) - - [Part 2](part2.md) -
This tutorial is broken in to multiple parts.
* Preface for the new programmer * Preface for the new programmer
* Part 0a: Configuring your running environment * Part 0a: Configuring your running environment
...@@ -23,23 +31,9 @@ This tutorial is broken in to multiple parts. ...@@ -23,23 +31,9 @@ This tutorial is broken in to multiple parts.
* Part 5: Event reconstruction * Part 5: Event reconstruction
Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text. ## Background Discussion
# Heading H1
Heading 1 text
## Heading H2
Heading 2 text
### Heading H3
Heading 3 text
#### Heading H4 <Background />
Heading 4 text
##### Heading H5
Heading 5 text
###### Heading H6
Heading 6 text
## Links
- http://hep-fcc.github.io/FCCSW/tutorials/FCCSW/Detector/doc/DD4hepInFCCSW.html
- https://dd4hep.web.cern.ch/
- https://dd4hep.web.cern.ch/dd4hep/reference/
Talks:
- https://indico.cern.ch/event/773049/contributions/3474743/attachments/1938118/3213628/gaede_dd4hep_chep19_v1.pdf
- CMS and DD4hep https://indico.cern.ch/event/773049/contributions/3474725/attachments/1935943/3212061/cmsDD4hepMigration.pdf
# gaudi
https://gaudi-framework.readthedocs.io/en/latest/index.html
# ACTS
# genfit
static/Argonne_color_black_transparent.png

9.67 KiB

static/Argonne_color_white_transparent.png

9.03 KiB

static/banner.png

38.3 KiB | W: | H:

static/banner.png

9.67 KiB | W: | H:

static/banner.png
static/banner.png
static/banner.png
static/banner.png
  • 2-up
  • Swipe
  • Onion skin
static/favicon.ico

14.7 KiB

static/favicon.png

10.6 KiB | W: | H:

static/favicon.png

1.9 KiB | W: | H:

static/favicon.png
static/favicon.png
static/favicon.png
static/favicon.png
  • 2-up
  • Swipe
  • Onion skin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment