Data

Tools

Indexes

Applications

Experiments

Open Source Science

epic

Geometry Description of the ePIC Experiment

https://github.com/eic/epic

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (3.4%) to scientific vocabulary

Keywords

dd4hep eic epic
Last synced: 6 months ago · JSON representation ·

Repository

Geometry Description of the ePIC Experiment

Basic Info
Statistics
  • Stars: 29
  • Watchers: 54
  • Forks: 50
  • Open Issues: 103
  • Releases: 55
Topics
dd4hep eic epic
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

README.md

CI status

Overview

craterlake

Detector geometry: - Empty viewer - Craterlake: viewer tgeo step - Subsystems: - Inner detector: viewer tgeo - Calorimetry: viewer tgeo - Imaging: viewer tgeo step - PID: viewer tgeo - dRICH: viewer tgeo step - pfRICH: viewer tgeo - DIRC: viewer tgeo step - Tracking: viewer tgeo step - Vertex: viewer tgeo - TOF: viewer tgeo - Beamline: viewer tgeo step

Detector parameters: - Craterlake: text toml csv html

Getting Started

Get a copy of the latest version from this repository: bash git clone https://github.com/eic/epic.git

Compilation

To configure, build, and install the geometry (to the install directory), use the following commands: bash cmake -B build -S . -DCMAKE_INSTALL_PREFIX=install cmake --build build cmake --install build To load the geometry, you can use the scripts in the install directory: bash source install/bin/thisepic.sh

Adding/changing detector geometry

Hint: Use the CI/CD pipelines.

To avoid dealing with setting up all the dependencies, we recommend using the continuous integration/continuous deployment (CI/CD) pipelines to make changes and assess their effects. Any feedback to help this process is appreciated.

Here is how to begin:

  1. Look at existing detector constructions and reuse if possible. Note that "compact detector descriptions" -> xml files, and "detector construction" -> cpp file.
  2. Modify xml file or detector construction.
  3. Create a WIP (or draft) merge request or pull request and look at the CI output for debugging. Then go to back to 2 if changes are needed.
  4. Remove the WIP/Draft part of the merge request if you would like to see your changes merged into the main.

See:

Compiling (avoid it)

First, see if the use case above is best for you. It most likely is and can save a lot of time for newcomers. To run the simulation locally, we suggest using the singularity image. More details can be found at the links below:

  • https://dd4hep.web.cern.ch/dd4hep/page/beginners-guide/
  • https://eic.phy.anl.gov/tutorials/eic_tutorial/
  • https://eicweb.phy.anl.gov/containers/eic_container/

Related useful links

Owner

  • Name: Electron-Ion Collider (EIC) Software
  • Login: eic
  • Kind: organization
  • Email: eic-software-l-owner@lists.bnl.gov

Electron-Ion Collider (EIC) software, documentation and resources

Citation (CITATION.cff) 

cff-version: 1.2.0
title: 'DD4hep Geometry Description of the EPIC Experiment'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: EPIC Collaboration
repository-code: 'https://github.com/eic/epic'
abstract: DD4hep Geometry Description of the EPIC Experiment

GitHub Events

Total
  • Create event: 145
  • Commit comment event: 2
  • Issues event: 19
  • Release event: 15
  • Watch event: 5
  • Delete event: 118
  • Issue comment event: 206
  • Push event: 520
  • Pull request review comment event: 119
  • Pull request event: 187
  • Pull request review event: 221
  • Fork event: 8
Last Year
  • Create event: 145
  • Commit comment event: 2
  • Issues event: 19
  • Release event: 15
  • Watch event: 5
  • Delete event: 118
  • Issue comment event: 206
  • Push event: 520
  • Pull request review comment event: 119
  • Pull request event: 187
  • Pull request review event: 221
  • Fork event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 34
  • Total pull requests: 217
  • Average time to close issues: 4 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 13
  • Total pull request authors: 30
  • Average comments per issue: 0.53
  • Average comments per pull request: 1.62
  • Merged pull requests: 146
  • Bot issues: 0
  • Bot pull requests: 31
Past Year
  • Issues: 7
  • Pull requests: 89
  • Average time to close issues: 3 days
  • Average time to close pull requests: 11 days
  • Issue authors: 5
  • Pull request authors: 20
  • Average comments per issue: 0.43
  • Average comments per pull request: 1.45
  • Merged pull requests: 49
  • Bot issues: 0
  • Bot pull requests: 14
View more stats
Top Authors
Issue Authors
  • wdconinc (9)
  • veprbl (6)
  • billlee77 (4)
  • ShujieL (4)
  • Chao1009 (4)
  • simonge (3)
  • rahmans1 (2)
  • kkauder (1)
  • aprozo (1)
  • sebouh137 (1)
  • joonsukbae (1)
  • Meatbally2 (1)
  • DraTeots (1)
  • jml985 (1)
  • ajentsch (1)
Pull Request Authors
  • wdconinc (76)
  • veprbl (49)
  • dependabot[bot] (20)
  • simonge (16)
  • ssedd1123 (11)
  • pre-commit-ci[bot] (11)
  • ShujieL (11)
  • sebouh137 (7)
  • mposik1983 (7)
  • epic-capybara (5)
  • Meatbally2 (5)
  • lkosarz (5)
  • michael-pitt (4)
  • ajentsch (4)
  • nat93 (3)
Top Labels
Issue Labels
topic: tracking (5) topic: infrastructure (3) topic: magnets (2) good first issue (2) enhancement (2) topic: barrel (2) topic: PID (1) topic: geometry (1) topic: simulation (1) topic: calorimetry (1) topic: documentation (1) topic: far-forward (1)
Pull Request Labels
topic: infrastructure (78) topic: PID (29) topic: calorimetry (26) topic: barrel (26) topic: tracking (23) topic: forward (20) dependencies (20) topic: far-forward (19) topic: magnets (15) topic: far-backward (14) topic: backward (13) topic: materials (8) topic: documentation (8) github_actions (4) review: changes requested (1) backport 24.05 (1) backport 24.03 (1) topic: geometry (1) topic: simulation (1) enhancement (1) backport 24.08 (1) backport 24.11 (1)

Dependencies

.github/workflows/generate-weekly-meeting-slides.yml actions
  • eic/generate-meeting-slides v2 composite
.github/workflows/labeler.yml actions
  • actions/labeler v4 composite
.github/workflows/linux-eic-shell.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/deploy-pages v1 composite
  • actions/download-artifact v3 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-artifact v3 composite
  • actions/upload-pages-artifact v1 composite
  • cvmfs-contrib/github-action-cvmfs v3 composite
  • eic/run-cvmfs-osg-eic-shell main composite
  • eic/trigger-gitlab-ci v2 composite
.github/workflows/linux-lcg.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • aidasoft/run-lcg-view v1 composite
  • cvmfs-contrib/github-action-cvmfs v3 composite
.github/workflows/spdx.yml actions
  • actions/checkout v3 composite
  • enarx/spdx 266ce9351a52b27e4bce5e1dbeecb23498f33add composite
requirements.txt pypi
  • jinja2 *
  • jinja2-cli *
Gemfile rubygems
  • github-pages >= 0 development
  • webrick >= 1.6.1
.github/workflows/pr-backport.yml actions
  • actions/checkout v3 composite
  • korthout/backport-action v1 composite