Metadata-Version: 2.1
Name: appletree
Version: 0.5.2
Summary: A high-Performance Program simuLatEs and fiTs REsponse of xEnon.
Home-page: https://github.com/XENONnT/appletree
Author: Appletree contributors, the XENON collaboration
Requires-Python: >=3.8,<3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
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 :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
Provides-Extra: docs
Requires-Dist: GOFevaluation
Requires-Dist: Jinja2 (==3.0.3) ; extra == "docs"
Requires-Dist: commonmark (==0.9.1) ; extra == "docs"
Requires-Dist: corner
Requires-Dist: emcee
Requires-Dist: graphviz
Requires-Dist: h5py
Requires-Dist: immutabledict
Requires-Dist: jax
Requires-Dist: lxml_html_clean ; extra == "docs"
Requires-Dist: m2r (==0.2.1) ; extra == "docs"
Requires-Dist: matplotlib
Requires-Dist: mistune (==0.8.4) ; extra == "docs"
Requires-Dist: multihist
Requires-Dist: nbsphinx (==0.8.9) ; extra == "docs"
Requires-Dist: numpy (<2.0.0)
Requires-Dist: numpyro
Requires-Dist: pandas
Requires-Dist: recommonmark (==0.7.1) ; extra == "docs"
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: sphinx (==5.2.3) ; extra == "docs"
Requires-Dist: sphinx_rtd_theme (==1.0.0) ; extra == "docs"
Requires-Dist: strax
Requires-Dist: utilix (>=0.11.0)
Project-URL: Repository, https://github.com/XENONnT/appletree
Description-Content-Type: text/markdown

# Appletree

A high-Performance Program simuLatEs and fiTs REsponse of xEnon.

[![DOI](https://zenodo.org/badge/534803881.svg)](https://zenodo.org/badge/latestdoi/534803881)
[![Test package](https://github.com/XENONnT/appletree/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/XENONnT/appletree/actions/workflows/pytest.yml)
[![Coverage Status](https://coveralls.io/repos/github/XENONnT/appletree/badge.svg?branch=master&kill_cache=1)](https://coveralls.io/github/XENONnT/appletree?branch=master&kill_cache=1)
[![PyPI version shields.io](https://img.shields.io/pypi/v/appletree.svg)](https://pypi.python.org/pypi/appletree/)
[![Readthedocs Badge](https://readthedocs.org/projects/appletree/badge/?version=latest)](https://appletree.readthedocs.io/en/latest/?badge=latest)
[![CodeFactor](https://www.codefactor.io/repository/github/xenonnt/appletree/badge)](https://www.codefactor.io/repository/github/xenonnt/appletree)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/XENONnT/appletree/master.svg)](https://results.pre-commit.ci/latest/github/XENONnT/appletree/master)

## Installation and Set-Up

### Regular installation:

With cpu support:

```
pip install appletree jax[cpu]
```

With CUDA Toolkit 11.2 support:

```
pip install appletree jax[cuda]==0.3.15 -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
```

With CUDA Toolkit 12.1 support:

```
pip install appletree jax[cuda12_pip] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
```

### Developer setup:

Clone the repository:

```
git clone https://github.com/XENONnT/appletree
cd appletree
```

To install the package and requirements in your environment, add `--user` in the above commands.

To install appletree in editable mode, insert `--editable` argument after `install` in the above `pip install` commands.

For example, to install in your environment and in editable mode with CUDA Toolkit 12.1 support:

```
pip install --editable . jax[cuda]==0.3.15 -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html --user
```

Then you are now good to go!

## Usage

The best way to start with the `appletree` package is to have a look at the tutorial `notebooks`.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

