Data

Tools

Indexes

Applications

Experiments

Open Source Science

d2eic

Detector 2 at the EIC

https://github.com/eic/d2eic

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 (14.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Detector 2 at the EIC

Basic Info
Statistics
  • Stars: 1
  • Watchers: 7
  • Forks: 1
  • Open Issues: 2
  • Releases: 0
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

Work in progress

This is a github repository for the Detector 2 at the EIC (D2EIC). This conceptual design of the detector is intended for the IP8.

The software infrastructure is based on the existing epic software, which shares a common ancestry.

This page is being developed. The contact persons now are Bill Li and Kong Tu

Dec 5 2023.

Overview

Detector geometry viewer: - Viewer only

Getting Started

Get a copy of the latest version from this repository: bash git clone https://github.com/eic/D2EIC.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/setup.sh or tcsh source install/setup.csh

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 D2EIC Experiment'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: D2EIC Collaboration
repository-code: 'https://github.com/eic/D2EIC'
abstract: DD4hep Geometry Description of the D2EIC Experiment

GitHub Events

Total
Last Year

Dependencies

LICENSE.spdx swiftpm
requirements.txt pypi
  • jinja2 *
  • jinja2-cli *
Gemfile rubygems
  • github-pages >= 0 development
  • webrick >= 1.6.1