danijak / phoenix

"Phoenix", a web-based event display for High Energy Physics

Phoenix

Phoenix is a TypeScript-based event display framework, using the popular three.js library for 3D. It focuses on being experiment agnostic by design, with common tools (such as custom menus, controls, propagators) and the possibility to add experiment specific extensions.

It consists of two packages: a plain TypeScript core library (phoenix-event-display) and Angular example application (phoenix-app). A React example is also provided. The core library can be adapted for any experiment with some simple steps.

Phoenix is supported by the HEP Software Foundation and is the official web event display of the ATLAS experiment.

It was selected for Google Summer of Code support in 2019 and 2020.

You can see an online version at https://hepsoftwarefoundation.org/phoenix/

Demo

Components

• Phoenix event display API - phoenix-event-display
• Phoenix application (Angular) - phoenix-app

Development

For running both the event display and the Angular app, you will need Node.js and lerna.

Once you have Node.js and npm installed (npm comes with Node.js), install lerna.

npm install --global lerna

Then run the following set of commands.

# Install all the required dependencies for both phoenix-event-display
# and phoenix-app and symlink the packages
npm run install:dependencies

# Run both packages in development (watch) mode
npm run start

Now both the phoenix-event-display and phoenix-app will start in development / watch mode. Any changes made to the phoenix-event-display will rebuild and hot reload the phoenix-app. You can access the app by navigating to http://localhost:4200 on the browser.

Documentation

• User manual
• Developer guide
• How to contribute
• API docs

Phoenix presentations

Phoenix was presented at the HSF/WLCG virtual workshop and the presentation can be watched on YouTube

Contact

Best is to either open an issue in GitHub, start a discussion or talk to us on our gitter channel.