README.md

Phoenix ODD

An Open Data Detector version of Phoenix.

Setup

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

To install yarn using npm package manager (which comes with Node.js).

npm install --global yarn

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

yarn install

(If you want to update the Phoenix version, make sure to edit package.json first)

To run in development mode:

yarn start

This will start Phoenix 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).

Deployment

You can deploy Phoenix with the command:

yarn deploy

This will put a static production/build version of Phoenix in the ./docs directory which you can copy to your server.
For example with the command: rsync -avz docs/ lxplus.cern.ch:/eos/project/h/hsf-phoenix/www/open-data-detector And to copy the api directory: rsync -avz api lxplus.cern.ch:/eos/project/h/hsf-phoenix/www/open-data-detector

Useful guides

• Complete user guide
• Deploy with a specific event
• Include in a web blog or article