Package: appletree
AppletreeA high-Performance Program simuLatEs and fiTs REsponse of xEnon.Installation and Set-UpRegular installation:With cpu support:pip install appletree[cpu]With CUDA Toolkit 11.2 support:pip install appletree[cuda112] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.htmlWith CUDA Toolkit 12.1 support:pip install appletree[cuda121] -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.htmlDeveloper setup:Clone the repository:git clone https://github.com/XENONnT/appletree
cd appletreeTo install the package and requirements in your environment, replacepip install appletree[*]topython3 -m pip install .[*] --userin the abovepipcommands.To install appletree in editable mode, insert--editableargument afterinstallin the abovepip installorpython3 -m pip installcommands.For example, to install in your environment and in editable mode with CUDA Toolkit 12.1 support:python3 -m pip install --editable .[cuda121] --user -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.htmlThen you are now good to go!UsageThe best way to start with theappletreepackage is to have a look at the tutorialnotebooks.ContributingPull 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.v0.3.1 / 2024-01-12Smarter SigmaMap handling and needed_parameters by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/116Move messages of used parameter inSigmaMap.buildby @dachengx inhttps://github.com/XENONnT/appletree/pull/117Set required_parameter as method of Config by @dachengx inhttps://github.com/XENONnT/appletree/pull/119Optional applying efficiency inmultiple_simulationsby @dachengx inhttps://github.com/XENONnT/appletree/pull/123Fix S1/S2 correction and gas gain when simulating S1/S2PE by @mhliu0001 inhttps://github.com/XENONnT/appletree/pull/122Prevent already cached functions from being changed by @dachengx inhttps://github.com/XENONnT/appletree/pull/125Update docstring to google style by @dachengx inhttps://github.com/XENONnT/appletree/pull/126Update conf, add napoleon by @dachengx inhttps://github.com/XENONnT/appletree/pull/127Small bug fix when no llh_name is used by @dachengx inhttps://github.com/XENONnT/appletree/pull/129New Contributors@mhliu0001 made their first contribution inhttps://github.com/XENONnT/appletree/pull/122Full Changelog:https://github.com/XENONnT/appletree/compare/v0.3.0...v0.3.1v0.3.0 / 2023-08-31Fix function name tosimulate_weighted_data, nothing else changed by @dachengx inhttps://github.com/XENONnT/appletree/pull/99Stop jax from preallocating memory by @dachengx inhttps://github.com/XENONnT/appletree/pull/100fix meshgrid binning by @hoetzsch inhttps://github.com/XENONnT/appletree/pull/101Binning is not required by Component by @dachengx inhttps://github.com/XENONnT/appletree/pull/103Upper clipping on binomial randgen in normal approx by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/107Rename fake maps by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/106Update fake maps filenames by @dachengx inhttps://github.com/XENONnT/appletree/pull/108Skip mongo DB when finding files by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/111Raise error if file does not exist by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/110Rename lce to correction by @dachengx inhttps://github.com/XENONnT/appletree/pull/109Add function to check the usage of configs, check_unused_configs by @dachengx inhttps://github.com/XENONnT/appletree/pull/112Proposal to use pre-commit for continuous integration by @dachengx inhttps://github.com/XENONnT/appletree/pull/113New Contributors@hoetzsch made their first contribution inhttps://github.com/XENONnT/appletree/pull/101Full Changelog:https://github.com/XENONnT/appletree/compare/v0.2.3...v0.3.0v0.2.3 / 2023-05-29Add pip install user by @dachengx inhttps://github.com/XENONnT/appletree/pull/96Installation with variousextras_requires for different CUDA support by @dachengx inhttps://github.com/XENONnT/appletree/pull/97Full Changelog:https://github.com/XENONnT/appletree/compare/v0.2.2...v0.2.3v0.2.2 / 2023-05-25Stop using MANIFEST.in, move to a modern way of file system configuration by @dachengx inhttps://github.com/XENONnT/appletree/pull/94Full Changelog:https://github.com/XENONnT/appletree/compare/v0.2.1...v0.2.2v0.2.1 / 2023-05-22Change variabless1s2tos1_areas2_areaby @dachengx inhttps://github.com/XENONnT/appletree/pull/86Remove duplicated import pd by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/87Generate number of events in the defined ROI by @dachengx inhttps://github.com/XENONnT/appletree/pull/88Update DOI link by @dachengx inhttps://github.com/XENONnT/appletree/pull/89Loosen requirement after beta phase and specify jax find-links by @dachengx inhttps://github.com/XENONnT/appletree/pull/90Update notebooks by @dachengx inhttps://github.com/XENONnT/appletree/pull/91Add more tests by @dachengx inhttps://github.com/XENONnT/appletree/pull/92Full Changelog:https://github.com/XENONnT/appletree/compare/v0.2.0...v0.2.1v0.2.0 / 2023-03-15Add NESTv2 yields parameterization and literature constrain by @dachengx inhttps://github.com/XENONnT/appletree/pull/82Add uncertainty on electron lifetime by @dachengx inhttps://github.com/XENONnT/appletree/pull/83Add NESTv2 NR parameters of quanta distribution's width by @dachengx inhttps://github.com/XENONnT/appletree/pull/85Full Changelog:https://github.com/XENONnT/appletree/compare/v0.1.0...v0.2.0v0.1.0 / 2023-02-12Add corner as dependency by @dachengx inhttps://github.com/XENONnT/appletree/pull/55Add .h5 backend to store MCMC results by @dachengx inhttps://github.com/XENONnT/appletree/pull/57Add document by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/61More docs by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/62Deduce and compile codes to generate Ly & Qy curve by @dachengx inhttps://github.com/XENONnT/appletree/pull/60Convert PDF spectrum to CDF by default by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/72Add R dimension for template generation by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/74Use specific config for certain llh by @dachengx inhttps://github.com/XENONnT/appletree/pull/78Config can read map and assign itself a mapping function by @dachengx inhttps://github.com/XENONnT/appletree/pull/79Stricter needed parameters check and save meta data to samples by @dachengx inhttps://github.com/XENONnT/appletree/pull/80Irregular binning option in likelihood by @xzh19980906 inhttps://github.com/XENONnT/appletree/pull/81Full Changelog:https://github.com/XENONnT/appletree/compare/v0.0.0...v0.1.0v0.0.0 / 2022-10-13Add more notebooks by @dachengx inhttps://github.com/XENONnT/appletree/pull/52Introduce numpyro as dependency by @dachengx inhttps://github.com/XENONnT/appletree/pull/53Try upload to pypi by @dachengx inhttps://github.com/XENONnT/appletree/pull/54Full Changelog:https://github.com/XENONnT/appletree/commits/v0.0.0