{"id":21492042,"url":"https://github.com/johannesbuchner/bxa","last_synced_at":"2025-05-07T15:45:25.986Z","repository":{"id":13720956,"uuid":"16415101","full_name":"JohannesBuchner/BXA","owner":"JohannesBuchner","description":"Bayesian X-ray analysis (nested sampling for Xspec and Sherpa)","archived":false,"fork":false,"pushed_at":"2024-05-06T10:11:28.000Z","size":57002,"stargazers_count":50,"open_issues_count":18,"forks_count":17,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-06T11:30:35.679Z","etag":null,"topics":["model-selection","nested-sampling","python","sherpa","spectroscopy","x-ray-astronomy","xspec"],"latest_commit_sha":null,"homepage":"https://johannesbuchner.github.io/BXA/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JohannesBuchner.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-01-31T17:32:17.000Z","updated_at":"2024-05-06T11:30:37.883Z","dependencies_parsed_at":"2024-01-02T08:09:45.315Z","dependency_job_id":"6da0484a-a382-463b-adb5-76970130beca","html_url":"https://github.com/JohannesBuchner/BXA","commit_stats":{"total_commits":546,"total_committers":9,"mean_commits":"60.666666666666664","dds":0.04029304029304026,"last_synced_commit":"027727baa3ecf71de1ee1ab360a23eae5c401d88"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2FBXA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2FBXA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2FBXA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohannesBuchner%2FBXA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohannesBuchner","download_url":"https://codeload.github.com/JohannesBuchner/BXA/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231449692,"owners_count":18378431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["model-selection","nested-sampling","python","sherpa","spectroscopy","x-ray-astronomy","xspec"],"created_at":"2024-11-23T15:21:43.310Z","updated_at":"2024-12-27T07:08:25.397Z","avatar_url":"https://github.com/JohannesBuchner.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"About Bayesian X-ray Analysis (BXA)\n------------------------------------\n\nBXA connects the X-ray spectral analysis environments Xspec/Sherpa\nto the nested sampling algorithm UltraNest \nfor **Bayesian Parameter Estimation** and **Model comparison**.\n\nBXA provides the following features:\n\n* parameter estimation in arbitrary dimensions, which involves:\n   * finding the best fit\n   * computing error bars\n   * computing marginal probability distributions\n   * parallelisation with MPI\n* plotting of spectral model vs. the data:\n   * for the best fit\n   * for each of the solutions (posterior samples)\n   * for each component\n* model selection:\n   * computing the evidence for the considered model, \n     ready for use in Bayes factors\n   * unlike likelihood-ratios, not limited to nested models \n* model discovery:\n   * visualize deviations between model and data with Quantile-Quantile (QQ) plots.\n     QQ-plots do not require binning and are more comprehensive than residuals.\n     This will give you ideas on when to introduce more complex models, which \n     may again be tested with model selection\n\nBXA shines especially\n\n* when systematically analysing a large data-set, or\n* when comparing multiple models\n* when analysing low counts data-set with realistic models\n\nbecause its robust and unsupervised fitting algorithm explores\neven complicated parameter spaces in an automated fashion.\nThe user does not need to initialise to good starting points.\nThe `algorithm \u003chttps://johannesbuchner.github.io/UltraNest/method.html\u003e`_ automatically runs until convergence, and slows down to sample\ncarefully if complicated parameter spaces are encountered. This allows building automated analysis pipelines.\n\n.. image:: https://img.shields.io/pypi/v/BXA.svg\n        :target: https://pypi.python.org/pypi/BXA\n\n.. image:: https://coveralls.io/repos/github/JohannesBuchner/BXA/badge.svg\n        :target: https://coveralls.io/github/JohannesBuchner/BXA\n\n.. image:: https://img.shields.io/badge/docs-published-ok.svg\n        :target: https://johannesbuchner.github.io/BXA/\n        :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/GitHub-JohannesBuchner%2FBXA-blue.svg?style=flat\n        :target: https://github.com/JohannesBuchner/BXA/\n        :alt: Github repository\n\nWho is using BXA?\n-------------------------------\n\n* Dr. Antonis Georgakakis, Dr. Angel Ruiz (NOA, Athens)\n* Dr. Mike Anderson (MPA, Munich)\n* Dr. Franz Bauer, Charlotte Simmonds (PUC, Jonathan Quirola Vásquez, Santiago)\n* Dr. Stéphane Paltani, Dr. Carlo Ferrigno (ISDC, Geneva)\n* Dr. Zhu Liu (NAO, Beijing)\n* Dr. Georgios Vasilopoulos (Yale, New Haven)\n* Dr. Francesca Civano, Dr. Aneta Siemiginowska (CfA/SAO, Cambridge)\n* Dr. Teng Liu, Adam Malyali, Riccardo Arcodia, Sophia Waddell, Torben Simm, ... (MPE, Garching)\n* Dr. Sibasish Laha, Dr. Alex Markowitz (UCSD, San Diego)\n* Dr. Arash Bahramian (Curtin University, Perth)\n* Dr. Peter Boorman (U of Southampton, Southampton; ASU, Prague)\n* and `you \u003chttps://ui.adsabs.harvard.edu/search/q=citations(bibcode%3A2014A%26A...564A.125B)%20full%3A%22BXA%22\u0026sort=date%20desc%2C%20bibcode%20desc\u0026p_=0\u003e`_?\n\nDocumentation\n----------------\n\nBXA's `documentation \u003chttp://johannesbuchner.github.io/BXA/\u003e`_ is hosted at http://johannesbuchner.github.io/BXA/\n\nInstallation\n-------------\n\nFirst, you need to have either `Sherpa`_ or `Xspec`_ installed and its environment loaded.\n\nBXA itself can installed easily using pip or conda::\n\n\t$ pip install bxa\n\nIf you want to install in your home directory, install with::\n\n\t$ pip install bxa --user\n\nThe following commands should not yield any error message::\n\n\t$ python -c 'import ultranest'\n\t$ python -c 'import xspec'\n\t$ sherpa\n\nYou may need to install python and some basic packages through your package manager. For example::\n\n\t$ yum install ipython python-matplotlib scipy numpy matplotlib\n\t$ apt-get install python-numpy python-scipy python-matplotlib ipython\n\nBXA requires the following python packages: requests corner astropy h5py cython scipy tqdm.\nThey should be downloaded automatically. If they are not, install them\nalso with pip/conda.\n\nThe source code is available from https://github.com/JohannesBuchner/BXA,\nso alternatively you can download and install it::\n\t\n\t$ git clone https://github.com/JohannesBuchner/BXA\n\t$ cd BXA\n\t$ python setup.py install\n\nOr if you only want to install it for the current user::\n\n\t$ python setup.py install --user\n\n**Supported operating systems**: \nBXA runs on all operating systems supported by \n`ciao/sherpa \u003chttps://cxc.cfa.harvard.edu/ciao/watchout.html#install\u003e`_ or \n`heasoft/xspec \u003chttps://heasarc.gsfc.nasa.gov/lheasoft/issues.html\u003e`_.\nThe support is systematically tested for every BXA release by \n`Travis CI \u003chttps://travis-ci.com/github/JohannesBuchner/BXA\u003e`_, but only for Ubuntu Linux.\n\n\nRunning\n--------------\n\nIn *Sherpa*, load the package::\n\n\tjbuchner@ds42 ~ $ sherpa\n\t-----------------------------------------------------\n\tWelcome to Sherpa: CXC's Modeling and Fitting Package\n\t-----------------------------------------------------\n\tCIAO 4.4 Sherpa version 2 Tuesday, June 5, 2012\n\n\tsherpa-1\u003e import bxa.sherpa as bxa\n\tsherpa-2\u003e bxa.BXASolver?\n\nFor *Xspec*, start python or ipython::\n\t\n\tjbuchner@ds42 ~ $ ipython\n\tIn [1]: import xspec\n\t\n\tIn [2]: import bxa.xspec as bxa\n\t\n\tIn [3]:\tbxa.BXASolver?\n\nNow you can use BXA. See the documentation pages for how\nto perform analyses. Several examples are included.\n\n.. _ultranest: http://johannesbuchner.github.io/UltraNest/\n\n.. _Sherpa: http://cxc.harvard.edu/sherpa/\n\n.. _Xspec: http://heasarc.gsfc.nasa.gov/docs/xanadu/xspec/\n\nCode\n-------------------------------\n\nSee the `code repository page \u003chttps://github.com/JohannesBuchner/BXA\u003e`_ \n\n.. _cite:\n\nCiting BXA correctly\n---------------------\n\nRefer to the `accompaning paper Buchner et al. (2014) \u003chttp://www.aanda.org/articles/aa/abs/2014/04/aa22971-13/aa22971-13.html\u003e`_ which gives introduction and \ndetailed discussion on the methodology and its statistical footing.\n\nWe suggest giving credit to the developers of Sherpa/Xspec, UltraNest and of this software.\nAs an example::\n\n\tFor analysing X-ray spectra, we use the analysis software BXA (\\ref{Buchner2014}),\n\twhich connects the nested sampling algorithm UltraNest (\\ref{ultranest})\n\twith the fitting environment CIAO/Sherpa (\\ref{Fruscione2006}).\n\nWhere the BibTex entries are:\n\n* for BXA and the contributions to X-ray spectral analysis methodology (model comparison, model discovery, Experiment design, Model discovery through QQ-plots):\n\n\t- Buchner et al. (2014) A\u0026A\n\t- The paper is available at `arXiv:1402.0004 \u003chttp://arxiv.org/abs/arXiv:1402.0004\u003e`_\n\t- `bibtex entry \u003chttps://ui.adsabs.harvard.edu/abs/2014A%26A...564A.125B/exportcitation\u003e`_\n\n* for UltraNest: see https://johannesbuchner.github.io/UltraNest/issues.html#how-should-i-cite-ultranest\n* for Sherpa: see `Sherpa`_\n* for Xspec: see `Xspec`_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannesbuchner%2Fbxa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohannesbuchner%2Fbxa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohannesbuchner%2Fbxa/lists"}