Difference between revisions of "EIC Software"

From Electron Ion Collider Wiki
Jump to: navigation, search
(Coordinate System)
(Coordinate System)
Line 114: Line 114:
 
  beam interaction point is at the origin.
 
  beam interaction point is at the origin.
 
  both beams are in the horizontal plane in the experimental hall which is xz plane in the frame.
 
  both beams are in the horizontal plane in the experimental hall which is xz plane in the frame.
  electron beam along -z axis, ion beam 50mrad away from +z axis with -x component for MEIC IP1 where the full acceptance detector is and +x component for MEIC IP2 where the high luminosity detector is
+
  electron beam along -z axis, ion beam 50mrad away from +z axis with -x component for MEIC IP1 where the full acceptance detector is and +x component  
y axis is vertical and +y pointing up relative to the ground
+
for MEIC IP2 where the high luminosity detector is y axis is vertical and +y pointing up relative to the ground x axis is horizontal and +x pointing  
x axis is horizontal and +x pointing right relative to the electron beam
+
right relative to the electron beam
 
  for example,  
 
  for example,  
 
  5GeV electron has momentum (0,0,-5) and 100GeV proton has momentum (100*sin(-50e-3),0,100*cos(-50e-3)) for MEIC IP1
 
  5GeV electron has momentum (0,0,-5) and 100GeV proton has momentum (100*sin(-50e-3),0,100*cos(-50e-3)) for MEIC IP1

Revision as of 16:07, 27 August 2015

Contents

introduction

Here is the information hub for the EIC software related to detectors.

The software is based on GEMC framework for detector simulation, JANA framework for event reconstruction. The physics event generation is independent.

The instruction for installation and how to use do event generation, simulation and reconstruction are listed below.

Info

communication, emaillist "meic_det_software at jlab.org" registration and archive

disk space, permanent /work/eic 1TB, temporary /volatile/eic 2TB, silo /mss/eic 10 TB

group area /group/eic 24GB

farm project "eic"

ask Pawel Nadel-Turonski <turonski@jlab.org> to add your jlab account into "eic" group to access disk space

quick start

This is a step by step guide to setup things to run the software including simulation, reconstruction etc.

All env variables required are setup by source file "set_eic"

make sure you meet the requirement here

The example below demonstrates how to setup in various cases.

(demonstration) on ifarm with official installation of framework and EIC repository

The fastest way to see what the simulation look like. You don't need to install any thing, but you can't modify anything either.

login into ifarm65.jlab.org with your jlab account (if you can't, ask jlab computer center help@jlab.org to make sure your account is allowed on ifarm machines)
source /home/zwzhao/eic/eic_svn/eic/set_eic
follow "compile and run" to run simulation (skip compiling)

(recommended) on ifarm with official installation of framework and your EIC repository

You don't need to install the framework, you can modify simulation configuration. This is the best way to run simulation on ifarm and farm nodes. This is recommend way to compare result and produce results.

login into ifarm65.jlab.org with your jlab account (if you can't, ask jlab computer center help@jlab.org to make sure your account is allowed on ifarm machines)
cd your_choice_of_eic_repo_path
svn co https://jlabsvn.jlab.org/svnroot/eic
cd eic
edit file set_eic by following the instruction within, you only need to change EIC_GEMC
source set_eic
follow "compile and run"  to compile and run simulation  (skip compiling)

(expert) on any machine with your installation of framework and your EIC repository

This gives you maximum freedom to use any version of framework and ability to work on your local machine, And allow you to modify anything. This is the way to run on your local machine.

install the framework by following installation instruction
cd your_choice_of_eic_repo_path
svn co https://jlabsvn.jlab.org/svnroot/eic
cd eic
edit file set_eic by following the instruction within
source set_eic
follow "compile and run" to compile and run simulation

Installation

introduction

Physics event generation is a collection of independent software packages.

Detector simulation is based on Geant4 based simulation framework GEMC http://gemc.jlab.org

Event reconstruction is based on framework JANA https://www.jlab.org/JANA

We have a unified framework of installing GEMC, JANA and all their dependances

EIC repository https://jlabsvn.jlab.org/svnroot/eic is for all EIC software

You need both the framework and EIC repository to use the software

installation of framework

The framework use environmental variable JLAB_VERSION to control version, so "setenv JLAB_VERSION 1.2" to set current version

The framework was tested on many platform, but for EIC use, it's only fully tested on Redhat flavoured linux like CentOS, RHEL, SL, Fedora so far

Detailed instruction is here installation of framework

installation of EIC repository

It's the central repository, everyone has read right, only jlab account within "eic" group can write to it

checkout by "svn co https://jlabsvn.jlab.org/svnroot/eic"
access its WebSVN interface at https://jlabsvn.jlab.org/eic
two ways to get auto notification about any change to SVN
use a graphic SVN client, for example "kdesvn"
use RSS feed on the Websvn interface

  • directory structure
    • "evgen", some event generators, (the others are in other repositories, see event generation section for details)
    • "eic_gemc", GEMC related files for EIC simulation
    • "eic_jana", eic event reconstruction code based on JANA
    • "study", files used for various studies
    • "subsystem", files used for various subsytems

A personal copy of EIC repository at /home/zwzhao/eic/eic_svn/eic/ on ifarm

You should download your own copy on ifarm or you local machine so you can tweak the code

Coordinate System

JLab MEIC uses the coordinate system below as "lab frame" for event generator output, detector arrangement and reconstruction

beam interaction point is at the origin.
both beams are in the horizontal plane in the experimental hall which is xz plane in the frame.
electron beam along -z axis, ion beam 50mrad away from +z axis with -x component for MEIC IP1 where the full acceptance detector is and +x component 
for MEIC IP2 where the high luminosity detector is y axis is vertical and +y pointing up relative to the ground x axis is horizontal and +x pointing 
right relative to the electron beam
for example, 
5GeV electron has momentum (0,0,-5) and 100GeV proton has momentum (100*sin(-50e-3),0,100*cos(-50e-3)) for MEIC IP1
5GeV electron has momentum (0,0,-5) and 100GeV proton has momentum (100*sin(50e-3),0,100*cos(50e-3)) for MEIC IP2

Physics Event Generation

Detector Simulation

Event Reconstruction

Study

Studies using the software tools are located here at the internal wiki requiring JLab account for access