Warning, /firebird/firebird-ng/src/assets/docs/intro.md is written in an unsupported language. File is not indexed.
0001 # EIC Event Display
0002
0003 # Introduction to Firebird
0004
0005 ## Overview
0006
0007 Firebird is a modern, web-based event display framework (built on [Phoenix event display](http://phoenix-dev.surge.sh) library) designed specifically for the Electron-Ion Collider (EIC) experiments. Built to serve both scientific and outreach purposes, Firebird provides a versatile platform for visualizing detector geometries, particle interactions, and physics processes in an intuitive and accessible manner.
0008
0009 As a core visualization tool for the EIC project, Firebird supports the needs of detector experts, physicists, and science communicators by offering a modular, extensible architecture that can adapt to evolving research requirements while maintaining ease of use.
0010
0011 ## Key Features
0012
0013 - **Web-based Architecture**: Access Firebird from any device with a web browser, whether deployed centrally or run locally for development
0014 - **Time-aware Visualization**: Full support for streaming readout data with 4D visualization capabilities
0015 - **Modular Design**: Extensible through plugins for customized data loaders, visualization styles, and analysis tools
0016 - **Interactive Analysis**: Examine detector components, track particles, and inspect physics data with intuitive controls
0017 - **Multi-experiment Support**: Designed for ePIC while maintaining compatibility with future IP8 detector and other experiments
0018 - **Comprehensive Data Handling**: Compatible with simulation outputs, reconstruction data, and raw detector signals
0019 - **Collaboration Tools**: Share visualizations and findings with colleagues through exportable views and states
0020
0021 ## Use Cases
0022
0023 ### Scientific Research and Analysis
0024
0025 Firebird serves as a powerful tool for researchers working on detector optimization, particle reconstruction algorithms, and physics analysis. Its ability to visualize complex data structures helps in understanding detector responses and particle interactions at a detailed level.
0026
0027 ### Debugging and Quality Control
0028
0029 For detector experts and software developers, Firebird offers specialized tools for debugging simulations, verifying reconstruction algorithms, and monitoring data quality. The framework integrates with continuous integration pipelines and supports automated testing workflows.
0030
0031 ### Education and Outreach
0032
0033 Firebird transforms complex scientific concepts into engaging visualizations suitable for presentations, publications, and public engagement. Its intuitive interface makes it accessible to audiences with varying levels of scientific knowledge.
0034
0035
0036 ## Development server
0037
0038 Run `ng serve` in `firebird-ng` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
0039
0040 # Firebird Data Exchange format
0041
0042 Data exchange is both JSON and Javascript object compatible.
0043
0044 It starts with `"type":"firebird-dex-json"` and the version, any custom origin info and a list of entries.
0045 In HENP physics `entry` may correspond to `event` data.
0046
0047 ```json
0048 {
0049 "type":"firebird-dex-json",
0050 "version": "0.01",
0051 "origin": {any custom origin info here"},"entries": [
0052 entry1, entry2, ...
0053 ]
0054 }
0055 ```
0056
0057 - **version** - is JSON schema version
0058 - **origin** - designed for any general custom info such as original file name,
0059 timestamp, simulation software version, etc.
0060 - **entries** - list of entries/events. The format is below.
