Metadata-Version: 2.3
Name: xenon-fuse
Version: 1.5.4
Summary: XENON Framework for Unified Simulations of Events
Author: Henning Schulze Eißing,
Author-email: h_schu55@uni-muenster.de
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: awkward (>=2.5.1)
Requires-Dist: immutabledict
Requires-Dist: nestpy (>=2.0.2)
Requires-Dist: numba (>=0.58.1)
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: periodictable
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: strax (>=1.6.0)
Requires-Dist: straxen (>=2.2.3)
Requires-Dist: timeout_decorator
Requires-Dist: uproot (>=5.2.1)
Requires-Dist: utilix (>=0.11.0)
Project-URL: Homepage, https://github.com/XENONnT/fuse
Description-Content-Type: text/markdown

# XENON fuse

[![PyPI version shields.io](https://img.shields.io/pypi/v/xenon-fuse.svg)](https://pypi.python.org/pypi/xenon-fuse/)
[![Coverage Status](https://coveralls.io/repos/github/XENONnT/fuse/badge.svg)](https://coveralls.io/github/XENONnT/fuse)
[![Test package](https://github.com/XENONnT/fuse/actions/workflows/pytest.yml/badge.svg?branch=main)](https://github.com/XENONnT/fuse/actions/workflows/pytest.yml)
[![Readthedocs Badge](https://readthedocs.org/projects/fuse/badge/?version=latest)](https://xenon-fuse.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/XENONnT/fuse/main.svg)](https://results.pre-commit.ci/latest/github/XENONnT/fuse/main)
[![DOI](https://zenodo.org/badge/622956443.svg)](https://zenodo.org/doi/10.5281/zenodo.11059395)

**F**ramework for **U**nified **S**imulation of **E**vents

fuse is the refactored version of the XENONnT simulation chain. The goal of this project is to unify [epix](https://github.com/XENONnT/epix) and [WFSim](https://github.com/XENONnT/WFSim) into a single program. fuse is based on the [strax framework](https://github.com/AxFoundation/strax), so that the simulation steps are encoded in plugins with defined inputs and outputs. This allows for a flexible and modular simulation chain.

## Installation

With all requirements fulfilled (e.g., on top of the [XENONnT montecarlo_environment](https://github.com/XENONnT/montecarlo_environment)):
```
python -m pip install xenon-fuse
```
or install from source:
```
git clone git@github.com:XENONnT/fuse
cd fuse
python -m pip install . --user
```

## Plugin Structure

The full simulation chain in split into multiple plugins. An overview of the simulation structure can be found below.

![fuse plugin structure](docs/source/figures/fuse_simulation_chain.png)

