Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 4.59 KB

README.md

File metadata and controls

98 lines (67 loc) · 4.59 KB
Raw

CERN CMS Event Visualization

A web application that visualizes particle trajectories of collision events in the CMS detector.

Built With

stars watchers license follow

About the project

This website contains a simple visualization of events observed at the Compact Muon Solenoid (CMS) detector at CERN. For some time I wanted to a project with some sort of visualization component (perhaps WebGl based). When I found out that CERN has a ton of data publically available, that sparked my curiosity (naturally). As such, I decided to build this web application to visualize these collision events (because that must look pretty cool).

Before you ask "but isn't there already an event display for this data", the answer is yes. When I got the idea for the project I did not know that though, and I thought it would be still be a fun project to do. Additionally, it is always nice to learn a bit about how these things work.

The website uses the CERN Open Data API to retrieve the displayable records. The visualization itself only displays the CMS detector itself (with the option of enabling/disabling the various parts) and the tracks produced by the collision event. The project is still under development, so more features might be added in the future.

Screenshot

Screenshot

Built With

Project Structure

Project Diagram

The front end makes a number of API requests to the back end to know which records/runs/events to display. As these requests in turn depend on the CERN API, this can make the website not as responsive as desired. To improve this, the API responses of the back end are cached using Redis. This can be done because the data will not change often and is not user-dependent, making all endpoints perfect for caching. This means that an initual request to a particular endpoint might take a small amount of time, but subsequent requests will be served from the cache.

Running the website locally

Ensure that you have Docker and Docker-Compose on your machine before you start.

  1. Start by cloning the repository:

    git clone https://github.com/BugelNiels/cepv.git

  2. Start the docker containers:

    docker-compose up

  3. Open your web browser and go to localhost.

It should be noted that at the moment only a development built is available. In the future, the web application will most likely receive a production build and be deployed somewhere.

Running API tests

The tests for the back end API can be run as follows:

  1. Navigate to the cepv-backend directory: 
    cd cepv-backend
  2. Create a python virtual environment: 
    python3 -m venv venv
  3. Activate the python virtual environment: 
    . .venv/bin/activate
  4. Install the necessary requirements: 
    pip install -r requirements.txt
  5. Run the tests: 
    python3 -m pytest

It should be noted that the tests currently depend on the fact that the CERN api is up and running. This is of course not ideal and can be solved by mocking the CERN api interface, which should make a number of tests less dependent on this. I have not gotten around to this yet though, so this issue is still open.

Useful links

The following are some resources I used while building the projects: