Package: alea-inference
aleaalea is a flexible statistical inference framework. The Python package is designed for constructing, handling, and fitting statistical models, computing confidence intervals and conducting sensitivity studies. It is primarily developed for theXENONnT dark matter experiment, but can be used for any statistical inference problem.If you use alea in your research, please consider citing the software published onzenodo.InstallationYou can install alea from PyPI using pip butbeware that it is listed there as alea-inference!Thus, you need to runpip install alea-inferenceFor the latest version, you can install directly from the GitHub repository by cloning the repository and runningcd alea
pip install .You are now ready to use alea!Getting startedThe best way to get started is to check out thedocumentationand have a look at ourtutorial notebooks. To explore the notebooks interactively, you can useBinder.Acknowledgementsaleais a public package inherited the spirits of previously private XENON likelihood definition and inference construction codebinferencethat based on the blueice repohttps://github.com/JelleAalbers/blueice.Binference was developed for XENON1T WIMP searches by Knut Dundas Morå, and for the first XENONnT results by Robert Hammann, Knut Dundas Morå and Tim Wolf.0.2.3 / 2024-02-22Improve check of already made toydata and output by @dachengx inhttps://github.com/XENONnT/alea/pull/128Combine several jobs into one to save computation resources by @dachengx inhttps://github.com/XENONnT/alea/pull/131Checklocateloaded package by @dachengx inhttps://github.com/XENONnT/alea/pull/134Updatehypothesesandcommon_hypothesisbypre_process_poiby @dachengx inhttps://github.com/XENONnT/alea/pull/135Print total number of submitted jobs by @dachengx inhttps://github.com/XENONnT/alea/pull/1370.2.2 / 2024-01-13Save dtype ofvalid_fitas bool by @dachengx inhttps://github.com/XENONnT/alea/pull/123Optional setting of random seed for debugging by @dachengx inhttps://github.com/XENONnT/alea/pull/122Tiny minor change on docstring by @dachengx inhttps://github.com/XENONnT/alea/pull/126Change example filename extension by @kdund inhttps://github.com/XENONnT/alea/pull/93Add axis_names to example templates by @hammannr inhttps://github.com/XENONnT/alea/pull/127Evaluateblueice_anchorsexpression by @dachengx inhttps://github.com/XENONnT/alea/pull/124Update pypi to use trusted publisher by @dachengx inhttps://github.com/XENONnT/alea/pull/130Update versions ofblueiceandinference-interfaceby @dachengx inhttps://github.com/XENONnT/alea/pull/1320.2.1 / 2023-12-08Add optional argumentdegree_of_freedomforasymptotic_critical_valueby @dachengx inhttps://github.com/XENONnT/alea/pull/86Update readthedocs configurations by @dachengx inhttps://github.com/XENONnT/alea/pull/88Update tutorials by @hammannr inhttps://github.com/XENONnT/alea/pull/89Add column to toyMC results with minuit convergence flag by @kdund inhttps://github.com/XENONnT/alea/pull/91Debug a typo at docstring of fittable parameter by @dachengx inhttps://github.com/XENONnT/alea/pull/95Improve documentation by @hammannr inhttps://github.com/XENONnT/alea/pull/101Update Neyman threshold when changing runner_args by @hammannr inhttps://github.com/XENONnT/alea/pull/100Allow submitter to skip the already succeeded files by @dachengx inhttps://github.com/XENONnT/alea/pull/94Print time usage ofRunner.runby @dachengx inhttps://github.com/XENONnT/alea/pull/104Get expectation values per likelihood term by @hammannr inhttps://github.com/XENONnT/alea/pull/106Prevent arguments to submission variations being changed by deepcopy-ing them.  by @dachengx inhttps://github.com/XENONnT/alea/pull/107Make error message more explicit that an excecutable is not found and… by @kdund inhttps://github.com/XENONnT/alea/pull/109Read poi and expectation directly fromoutput_filenameto accelerateNeymanConstructorby @dachengx inhttps://github.com/XENONnT/alea/pull/108Direct call of used parameters of model by @dachengx inhttps://github.com/XENONnT/alea/pull/112Add function to get all sources names from all likelihoods by @dachengx inhttps://github.com/XENONnT/alea/pull/111Make sure values of parameters that need re-initialization are not changed by @hammannr inhttps://github.com/XENONnT/alea/pull/110Allow all computation names by @kdund inhttps://github.com/XENONnT/alea/pull/116Debug for the missing argument in_read_poiby @dachengx inhttps://github.com/XENONnT/alea/pull/118Remove unnecessary warning given new ptype constraints by @dachengx inhttps://github.com/XENONnT/alea/pull/119Full Changelog:https://github.com/XENONnT/alea/compare/v0.2.0...v0.2.10.2.0 / 2023-09-01Proposal to use pre-commit for continuous integration by @dachengx inhttps://github.com/XENONnT/alea/pull/78Example notebooks by @hammannr inhttps://github.com/XENONnT/alea/pull/75Simplify TemplateSource, CombinedSource and SpectrumTemplateSource by @dachengx inhttps://github.com/XENONnT/alea/pull/69[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci inhttps://github.com/XENONnT/alea/pull/80[pre-commit.ci] pre-commit autoupdate by @pre-commit-ci inhttps://github.com/XENONnT/alea/pull/82Add Submitter and NeymanConstructor by @dachengx inhttps://github.com/XENONnT/alea/pull/79New Contributors@pre-commit-ci made their first contribution inhttps://github.com/XENONnT/alea/pull/80Full Changelog:https://github.com/XENONnT/alea/compare/v0.1.0...v0.2.00.1.0 / 2023-08-11Unify and clean code style and docstring by @dachengx inhttps://github.com/XENONnT/alea/pull/68First runner manipulating statistical model by @dachengx inhttps://github.com/XENONnT/alea/pull/50Set best_fit_args to confidence_interval_args if None by @kdund inhttps://github.com/XENONnT/alea/pull/76Livetime scaling by @kdund inhttps://github.com/XENONnT/alea/pull/73Full Changelog:https://github.com/XENONnT/alea/compare/v0.0.0...v0.1.00.0.0 / 2023-07-28readme update with pointer to previous work in lieu of commit history by @kdund inhttps://github.com/XENONnT/alea/pull/8Adds a statistical model base class (under construction by @kdund inhttps://github.com/XENONnT/alea/pull/7change folder/module name by @kdund inhttps://github.com/XENONnT/alea/pull/9Move submission_script.py also from binference to here by @dachengx inhttps://github.com/XENONnT/alea/pull/10Add simple gaussian model by @hammannr inhttps://github.com/XENONnT/alea/pull/12Parameter class by @hammannr inhttps://github.com/XENONnT/alea/pull/19Confidence intervals by @kdund inhttps://github.com/XENONnT/alea/pull/27Update README.md by @kdund inhttps://github.com/XENONnT/alea/pull/29Init code style checking, pytest, and coverage by @dachengx inhttps://github.com/XENONnT/alea/pull/31Add templates for wimp example by @hoetzsch inhttps://github.com/XENONnT/alea/pull/30Removes all hash for parameters not used for each source, and for all… by @kdund inhttps://github.com/XENONnT/alea/pull/37First implementation of an nT-like likelihood by @hammannr inhttps://github.com/XENONnT/alea/pull/32Check if some parameter is not set as guess when fitting by @kdund inhttps://github.com/XENONnT/alea/pull/44Fix likelihood_names check in statistical_model.store_data to handle unnamed likelihoods by @kdund inhttps://github.com/XENONnT/alea/pull/45Create pull_request_template.md by @dachengx inhttps://github.com/XENONnT/alea/pull/46Codes style cleaning by @dachengx inhttps://github.com/XENONnT/alea/pull/49First runner manipulating statistical model by @dachengx inhttps://github.com/XENONnT/alea/pull/47Run test on main not master by @dachengx inhttps://github.com/XENONnT/alea/pull/55Simplify file structure by @dachengx inhttps://github.com/XENONnT/alea/pull/51Moveblueice_extended_modeltomodelsby @dachengx inhttps://github.com/XENONnT/alea/pull/56Change data format to only use structured arrays  by @kdund inhttps://github.com/XENONnT/alea/pull/42Another fitting test by @kdund inhttps://github.com/XENONnT/alea/pull/59Add first tests module and file indexing system by @dachengx inhttps://github.com/XENONnT/alea/pull/54Shape parameters by @hammannr inhttps://github.com/XENONnT/alea/pull/58Recover examples folder, update file indexing, add notebooks folder, remove legacies by @dachengx inhttps://github.com/XENONnT/alea/pull/61Remove pdf_cache folder before pytest by @dachengx inhttps://github.com/XENONnT/alea/pull/65Make 0.0.0, initialize documentation structure based on readthedocs, add badges to README by @dachengx inhttps://github.com/XENONnT/alea/pull/66New Contributors@kdund made their first contribution inhttps://github.com/XENONnT/alea/pull/8@dachengx made their first contribution inhttps://github.com/XENONnT/alea/pull/10@hammannr made their first contribution inhttps://github.com/XENONnT/alea/pull/12@hoetzsch made their first contribution inhttps://github.com/XENONnT/alea/pull/30