Welcome to revertex’s documentation!

revertex is a python package to generate event vertices for remage. The package contains tools to generate a variety of different vertices both with dedicated python functions, and on the command line, following the defined specification.

Getting started

The latest tagged version and all its dependencies can be installed from PyPI: pip install revertex.

Alternatively, the packages’s development version can be installed from a git checkout: pip install -e . (in the directory of the git checkout).

Now you are ready to generate some event vertices. For most cases this can be done using the command line:

$ revertex -h

and then following the instructions to generate vertices for a specific case.

If you want to use revertex tools to generate vertices directly in python code see the next section!

Generator specification (advanced)

The package consists of some “core” functionality, for example to format the output correctly for remage and also a set of specific generators. For these functions we use the following specification:

  • A position generator should be written as a function with size and seed as required arguments,

  • All other options should be given by keyword arguments

  • The code should return a 2D numpy array of each generated (x,y,z) position.

This allows the “core” functionality of revertex to easily handle generation of the vertices in chunks, and conversion to the correct output format.

More details