Metadata-Version: 2.1
Name: lhcb-rex
Version: 0.1.3
Summary: Generalised graph neural network based fast simulation tool for LHCb.
Author-email: Alex Marshall <alex.marshall@cern.ch>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: alexplot
Requires-Dist: appdirs >=1.4.4
Requires-Dist: diffusers >=0.33.1
Requires-Dist: geomloss >=0.2.6
Requires-Dist: huggingface-hub >=0.32.4
Requires-Dist: matplotlib >=3.9.4
Requires-Dist: pandas >=2.3.1
Requires-Dist: pip >=25.1.1
Requires-Dist: psutil >=7.0.0
Requires-Dist: pydantic >=2.11.7
Requires-Dist: pytest >=8.3.5
Requires-Dist: pytorch-lightning >=2.3.3
Requires-Dist: rich >=14.1.0
Requires-Dist: scikit-learn ==1.4.1.post1
Requires-Dist: tensorboard >=2.20.0
Requires-Dist: termcolor >=3.1.0
Requires-Dist: torch ==2.0.1
Requires-Dist: torch-geometric >=2.6.1
Requires-Dist: tqdm >=4.67.1
Requires-Dist: uproot >=5.5.2
Requires-Dist: uproot3 >=3.14.4
Requires-Dist: vector ==0.8.0

<!-- # ![Rex Banner](./src/lhcb_rex/tools/figures/Rex_banner.png) -->
# ![Rex Banner](https://github.com/alexmarshallbristol/Rex-image/blob/master/Rex_banner.png?raw=true)

# Rex 

```Rex``` offers a fast emulation of the LHCb detector simulation. From truth level kinematics to reconstructed quantities and all commonly used reconstruction quality variables. 

## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Usage](#usage)

## About

A full description of the tool can be found in this [📖 arXiv preprint](https://arxiv.org/abs/2507.05069/). 

[📖 Project Docs](https://lhcb-rex.docs.cern.ch/) | [💬 Mattermost Chat](https://mattermost.cern.ch/your-channel) | [📬 Developer Email](mailto:alex.marshall@bristol.ac.uk)

## Installation 

### Prerequisites  
- Python 3.9

Install with ```pip```:
```shell
pip install lhcb-rex
```

## Usage

Examples below

<details>
    <summary>Click to see an example</summary>

```python
import lhcb_rex

lhcb_rex.run(
    events=1000,
    decay="Bs0 -> mu+ mu-",
    naming_scheme="MOTHER -> DAUGHTER1 DAUGHTER2",
    decay_models="PHSP -> NA NA",
    workingDir="./Bs_mumu",
)
```

</details>

## Installation for development

```shell
git clone
uv sync
uv run pip install -e .
```

---

📬 Have questions? Reach out at [alex.marshall@bristol.ac.uk](mailto:alex.marshall@bristol.ac.uk)


### Notes for me

```/dice/users/am13743/fast_vertex_quality/graveyard```
```/dice/users/am13743/fast_vertex_quality/checkpoints/```

Relevant tags/checkpoints:
- ```21_03_2025``` - Plotting for paper draft

```shell
rm -rf dist/
uv build
uv publish
```
