Skip to content

ATLAS-experiment/PhoenixATLAS

Repository files navigation

Phoenix ATLAS

An ATLAS version of the Phoenix cross-experiment event display. The live version of PhoenixATLAS is here, which can be used to browse example events, or upload your own (JiveXML and JSON are supported).

PhoenixATLAS has also been used as an embedded event display in some Physics Briefings e.g. New high-precision measurements of W and Z boson properties and Not a jet all the way: is dark matter hiding in plain sight?. Have a look at the documentation if you would like to do the same, or to make a QR code for use in e.g. a poster.

PhoenixATLAS is also used to display recent collisions on the ATLAS Live Event Browser - you need to click on an event, and then click on "Open this Event in Phoenix live".

Tips for users

  • Most of the user interface is identical to phoenix, and so the phoenix user guide should be the first place to start.
  • The following explains how to use PhoenixATLAS in a poster, or blog article:
  • Additionally, for PhoenixATLAS we have some example events which can be reached through the Event Browser popup, selectable on the far right of the bottom menu (highlighted in red below):
Screenshot 2023-06-01 at 13 15 47

Tips for developers

Setup

To setup, you will need Node.js and yarn.

To install yarn using corepack:

corepack enable

Once you have Node.js and yarn set up you can run this command to install the dependencies:

yarn install
# For macOS you need to make sure you have done: brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman

To run in development mode:

yarn start

This will start Phoenix ATLAS locally which you can access through the URL http://localhost:4200.

Remember that this is using a local app, and so if you want to update the base configuration then you will need to edit this (i.e. if you want to change the geometry, or the configuration).

Updating to the newest version of Phoenix

This can be done with e.g.:

yarn upgrade phoenix-event-display@latest phoenix-ui-components@latest

or use:

yarn upgrade-interactive

to upgrade many dependencies at the same time (see the yarn https://classic.yarnpkg.com/lang/en/docs/cli/upgrade-interactive/ for more details on this command).

Deployment

You can deploy Phoenix with the command:

yarn deploy

This will put a static production/build version of Phoenix ATLAS in the ./docs directory which you can copy to your server.
For example with the command: rsync -avz docs/ lxplus.cern.ch:/eos/atlas/atlascerngroupdisk/proj-phoenixatlas/www/atlas

This is accessible at https://phoenixatlas.web.cern.ch/PhoenixATLAS

Or for dev: rsync -avz docs/ lxplus.cern.ch:/eos/atlas/atlascerngroupdisk/proj-phoenixatlas/www/atlas-dev

which is accessible at https://phoenixatlastest.web.cern.ch

The following shows how to roll a new version of PhoenixATLAS, with a dedicated event as default.

Useful guides