Metadata-Version: 2.4
Name: velopix
Version: 0.8.2
Requires-Dist: numpy>=2.0.2
Requires-Dist: pandas>=2.2.3
Requires-Dist: scipy>=1.13.1
Requires-Dist: scikit-learn>=1.6.1
Requires-Dist: typing-extensions==4.14.0
License-File: LICENSE
Summary: CERN VeloPix Detector Framework & Hyperparameter Optimiser
Keywords: rust,python,velopix,CERN,particle physics,physics,maturin,lhcb,track reconstruction,optimisation
Author: Sven Hockers
Author-email: Sven Hockers <svenhockers1@gmail.com>
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Source Code, https://github.com/SvenHockers/velopix

# velopix

**Velopix** is a high-performance track reconstruction framework designed for processing collision data from the LHCb detector at CERN. It reconstructs particle trajectories by analyzing hit patterns recorded across multiple detector modules.

---

## Overview

The package provides a complete reconstruction pipeline along with multiple algorithms and tools for validation and analysis. It is intended for use in high-energy physics data workflows, particularly for experiments that involve tracking particles across layered detector systems.

---

## Features

- Track reconstruction from raw detector hit data
- Multiple algorithmic approaches:
  - Track-Following
  - Graph-based Depth-First Search (DFS)
  - Merged-Triplet Tree Search
- Efficient event parsing and data representation
- Built-in validation metrics:
  - Hit efficiency
  - Track purity
  - Clone and ghost detection
- Modular and extensible design for algorithm development and optimization

---

## Use Cases

Velopix is designed for:

- Physicists analyzing detector data from the LHCb experiment
- Developers comparing or building custom reconstruction algorithms
- Research teams building end-to-end pipelines for particle tracking

---

## Documentation

Full documentation is available online:

- [Installation Guide](https://github.com/SvenHockers/velopix/blob/main/docs/installation.md)
- [System Overview](https://github.com/SvenHockers/velopix/blob/main/docs/installation.md)
- [API Reference](https://github.com/SvenHockers/velopix/blob/main/docs/api.md)

---

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/SvenHockers/velopix/blob/main/LICENSE) file for details.

