A high-Performance Program simuLatEs and fiTs REsponse of xEnon.
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
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!
The best way to start with the appletree
package is to have a look at the tutorial notebooks
.
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.