Back to home page

EIC code displayed by LXR

 
 

    


Warning, /firebird/README.md is written in an unsupported language. File is not indexed.

0001 # Electron Ion Collider dynamic visualization
0002 **(aka EIC Event Display)**
0003 
0004 [![Frontend CI/CD Workflow](https://github.com/eic/firebird/actions/workflows/frontend.yaml/badge.svg?branch=main)](https://github.com/eic/firebird/actions/workflows/frontend.yaml)
0005 
0006 
0007 WORKING DISPLAY IS NOW HERE: 
0008 
0009 [seeEIC.org](seeeic.org)
0010 
0011 The documentation 
0012 
0013 https://eic.github.io/firebird/
0014 
0015 
0016 ## Project Overview
0017 
0018 
0019 <a href="https://eic.github.io/firebird/">
0020 <img src="firebird-ng/src/assets/doc/media/eic_dis_animation_v7.gif" title="EIC ePIC DIS event" />
0021 </a>
0022 
0023 **Firebird** is a web-based event display framework for particle physics experiments, 
0024 specifically designed for the Electron-Ion Collider (EIC). 
0025 It visualizes detector geometries, detector responses (hits), particle trajectories, 
0026 and physics processes using modern web technologies. 
0027 Firebird serves research, debugging/QC, and educational purposes.
0028 
0029 
0030 ## Repository Structure
0031 
0032 This is a **monorepo** containing three interdependent components:
0033 
0034 - **firebird-ng/** - Angular frontend (TypeScript, Three.js, RxJS)
0035 - **pyrobird/** - Python Flask backend (file server for local run, ROOT conversion)
0036 - **dd4hep-plugin/** - C++ Geant4/DD4Hep plugin (trajectory extraction during simulation)
0037 - **docs/** - rspress markdown based documentation (hosted on github-pages)
0038 
0039 The documentation source lives in 
0040 - `firebird-ng/src/assets/doc`
0041 
0042