Skip to main content

MATHUSLA Particle Tracker

Codacy Badge

a time-based tracking library for particle physics experiments

Projects

Name Description Location (demo/) Status
Prototype MATHUSLA Test Stand at P1 prototype/ FUNCTIONAL
Box MATHUSLA Full Box box/ INCOMPLETE
ModuleBox MATHUSLA Full Box with Modules module_box/ INCOMPLETE

The tracking library comes with a project directory demo which holds the MATHUSLA Test Stand Prototype tracking code (see demo/prototype). More projects to be added soon.

Tracking Script

The tracking script is a configuration file which allows the user to specify details of the tracking algorithm. Here is a list of allowed keys and their associated value types.

Key Value Type Description
verbose-output boolean type of output to terminal
draw-events boolean type of event display mode
geometry-file file path path to GDML geometry file
geometry-map-file file path path to geometry map
geometry-default-time-error positive real default time resolution of detector volumes
statistics-directory directory path path to output statistics
statistics-file-prefix prefix string prefix name for output file
statistics-file-extension extension string extension to file (or filetype)
data-directory directory path path to ROOT data to be processed
data-file-extension extension string extension to file (or filetype)
data-position-keys string for each of R4 data key read-in for position
data-position-error-keys string for each of R4 data key read-in for position error
data-detector-key string data key read-in for detector
data-track-id-key string data key read-in for track id
data-parent-id-key string data key read-in for parent id
data-momentum-keys string for each of R4 data key read-in for momentum
time-smearing boolean mode for smearing time input on resolution
layer-axis R3 coordinate direction for track parameterization
layer-depth positive real layer size for geometry approximation
line-width positive real tolerance for line approximation
seed-size positive integer number of points per seed
event-density-limit positive real < 1 density limit before event is dropped

Building

The tracker comes with a simple build script called install which allows for build customization of the tracking library.

Here is a list of useful command line options:

Action Options for ./install
Build Only none
Build and Auto Run --run (see below)
Clean CMake Build --cmake --clean
More Options --help

After a successful run of ./install, the entire tracking library is built and all of the demo projects are installed. The build directory is created which stores all of the binaries and libraries associated with the tracker.

At the moment the tracking library only comes with one complete "project tracker" so running ./install --run will automatically run the prototype executable from build/demo/. Here is a list of command line options that the Prototype uses:

Action Short Options Long Options
Geometry File -g <filepath> --geometry=<filepath>
Detector Map -m <filepath> --map=<filepath>
ROOT Data Directory -d <directory> --data=<directory>
Custom Tracking Script -s <file> --script=<file>
Quiet Mode -q --quiet
Help -h --help

The tracking script can provide the all of the detail above to the tracker and will eventually replace all command line arguments.

Metadata

Release files for mathusla-tracker 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mathusla-tracker 0.0.2
File Size Uploaded Provenance Actions
mathusla-tracker-0.0.2.tar.gz 8.9 kB Without provenance Details for mathusla-tracker-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mathusla-tracker 0.0.2
File Interpreter ABI Platform Actions
mathusla_tracker-0.0.2-py2.py3-none-any.whl Python 2, Python 3 none any Details for mathusla_tracker-0.0.2-py2.py3-none-any.whl

Total release size: 30.9 kB

Release files / mathusla-tracker-0.0.2.tar.gz

Download URL mathusla-tracker-0.0.2.tar.gz
Size 8.9 kB
Tags Source
SHA-256 checksum
How to use checksums
991568c53376be6227ee298060ea0942f93b475cc3a6d5d9ebd2ce8b0eb436c3
BLAKE2b-256 checksum
How to use checksums
834509bc7c82c606793b0af30feb6db810d8ca2e5da48c9557e4f9368a1ded01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

Release files / mathusla_tracker-0.0.2-py2.py3-none-any.whl

Download URL mathusla_tracker-0.0.2-py2.py3-none-any.whl
Size 22.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
51e2c333cde35240a85b2315de884fe81c847e33fb1feae5410ef4b38f4fff0e
BLAKE2b-256 checksum
How to use checksums
4d9010ec92b8a57ad36477d118ae60418169da241a7722801538cfffb3766c12
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.2

Security for mathusla-tracker 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page