CLI Reference¶

The following CLI provides a web interface to interactive with HEP data. In order to use it, you must install colliderscope with the optional webui dependencies, ie.

pip install "colliderscope[webui]"

After running this, it should be possible to execute the following commands from your terminal without exceptions.

Note

This assumes you already have pythia8, compiled with the Python interface, installed in your development environment. If you do not, you can install it via conda from the conda-forge channel. See the showerpipe documentation for more information.

colliderscope¶

Initiates an interactive web-app to simulate and display the particle collisions stored in LHE_PATH, running Pythia 8 over the events, using the settings provided in PYTHIA_CONFIG_PATH (typically a file with the extension .cmnd).

colliderscope [OPTIONS] LHE_PATH PYTHIA_CONFIG_PATH

Options

-l, --log-level <log_level>¶

Minimum debugging level to include within logs.

Default:¶: WARNING
Options:¶: DEBUG | INFO | WARNING | ERROR | CRITICAL

-p, --port <port>¶

Port number that server will open.

Default:¶: 8050

Arguments

LHE_PATH¶: Required argument

PYTHIA_CONFIG_PATH¶: Required argument

Last update: Jun 27, 2025