======
BEANSp
======
.. .. image:: https://img.shields.io/pypi/v/beans.svg
.. :target: https://pypi.python.org/pypi/beans
.. .. image:: https://img.shields.io/travis/adellej/beans.svg
.. :target: https://travis-ci.org/adellej/beans
.. .. image:: https://readthedocs.org/projects/beans/badge/?version=latest
.. :target: https://beans.readthedocs.io/en/latest/?badge=latest
.. :alt: Documentation Status
Bayesian Estimation of Accreting Neutron Star parameters
-----------------------------------------------------------------
* Free software: MIT license
* Documentation: https://beans-7.readthedocs.io/en/latest/
* Repo: https://github.com/adellej/beans
Features
--------
This software uses a Markov Chain Monte Carlo approach to match observations of an accreting neutron star in outburst with a simple ignition model to constrain parameters including the neutron star mass, radius, surface gravity, distance and system inclination, and accreted fuel composition.
The code is written in Python 3, except for settle which is a C++ code with a python wrapper. It makes use of Dan Foreman-Mackey's python implementation of MCMC, emcee, available at https://github.com/dfm/emcee.
Credits
-------
Software written by Adelle Goodwin and Duncan Galloway; for a full description see Goodwin et al. (2019, https://doi.org/10.1093/mnras/stz2638 or preprint at https://arxiv.org/pdf/1907.00996).
The original algorithm is described in Galloway & Cumming (2006,
https://iopscience.iop.org/article/10.1086/507598).
pySettle was forked from the original settle written by Andrew Cumming and
available at https://github.com/andrewcumming/settle
Package installation and usage
------------------------------
BEANSp is on pyPI (https://pypi.org/project/beansp/) so installation is
easy - either system-wide, or in virtual environment:
.. code-block:: console
pip install beansp
You can then import the main ``Beans`` module as follows:
.. code-block:: python
from beansp import Beans
(Please refer to `this simple test script <https://github.com/adellej/beans/blob/master/tests/test_sft_beans.py>`_ as an example.)
Build and installation from this github repository
--------------------------------------------------
Please refer to `build instructions <https://github.com/adellej/beans/blob/master/BUILD.rst>`_.
=======
History
=======
0.1.0 (2019-09-19)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/adellej/beans",
"name": "beansp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "",
"keywords": "beans",
"author": "",
"author_email": "adelle.goodwin@curtin.edu.au",
"download_url": "https://files.pythonhosted.org/packages/3c/d1/769ec4f7b4beb38f844ca22b48cc17fd12cd3150c9c03457f2a79d1d5011/beansp-2.25.0.tar.gz",
"platform": null,
"description": "======\nBEANSp\n======\n\n\n.. .. image:: https://img.shields.io/pypi/v/beans.svg\n.. :target: https://pypi.python.org/pypi/beans\n\n.. .. image:: https://img.shields.io/travis/adellej/beans.svg\n.. :target: https://travis-ci.org/adellej/beans\n\n.. .. image:: https://readthedocs.org/projects/beans/badge/?version=latest\n.. :target: https://beans.readthedocs.io/en/latest/?badge=latest\n.. :alt: Documentation Status\n\n\n\nBayesian Estimation of Accreting Neutron Star parameters\n-----------------------------------------------------------------\n\n* Free software: MIT license\n* Documentation: https://beans-7.readthedocs.io/en/latest/\n* Repo: https://github.com/adellej/beans\n\n\nFeatures\n--------\n\nThis software uses a Markov Chain Monte Carlo approach to match observations of an accreting neutron star in outburst with a simple ignition model to constrain parameters including the neutron star mass, radius, surface gravity, distance and system inclination, and accreted fuel composition. \n\nThe code is written in Python 3, except for settle which is a C++ code with a python wrapper. It makes use of Dan Foreman-Mackey's python implementation of MCMC, emcee, available at https://github.com/dfm/emcee.\n\nCredits\n-------\n\nSoftware written by Adelle Goodwin and Duncan Galloway; for a full description see Goodwin et al. (2019, https://doi.org/10.1093/mnras/stz2638 or preprint at https://arxiv.org/pdf/1907.00996).\n\nThe original algorithm is described in Galloway & Cumming (2006, \nhttps://iopscience.iop.org/article/10.1086/507598).\n\npySettle was forked from the original settle written by Andrew Cumming and\navailable at https://github.com/andrewcumming/settle\n\nPackage installation and usage\n------------------------------\nBEANSp is on pyPI (https://pypi.org/project/beansp/) so installation is\neasy - either system-wide, or in virtual environment:\n\n.. code-block:: console\n \n pip install beansp\n \nYou can then import the main ``Beans`` module as follows:\n \n.. code-block:: python\n \n from beansp import Beans \n\n(Please refer to `this simple test script <https://github.com/adellej/beans/blob/master/tests/test_sft_beans.py>`_ as an example.)\n\nBuild and installation from this github repository\n--------------------------------------------------\n\nPlease refer to `build instructions <https://github.com/adellej/beans/blob/master/BUILD.rst>`_.\n\n\n\n\n=======\nHistory\n=======\n\n0.1.0 (2019-09-19)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Bayesian Estimation of Accreting Neutron Stars parameters",
"version": "2.25.0",
"project_urls": {
"Homepage": "https://github.com/adellej/beans"
},
"split_keywords": [
"beans"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a84b8e83398c846cf52e96611ad2e5a49a8ea4eda118c33c6c35add022150a4",
"md5": "3484220e9cc6838f60509a618a9a82e1",
"sha256": "16a8142843ecb81695251efe6a0af6677893e8bb36aa8224b65036370b090d33"
},
"downloads": -1,
"filename": "beansp-2.25.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3484220e9cc6838f60509a618a9a82e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 657762,
"upload_time": "2024-03-16T05:05:55",
"upload_time_iso_8601": "2024-03-16T05:05:55.184666Z",
"url": "https://files.pythonhosted.org/packages/2a/84/b8e83398c846cf52e96611ad2e5a49a8ea4eda118c33c6c35add022150a4/beansp-2.25.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cd1769ec4f7b4beb38f844ca22b48cc17fd12cd3150c9c03457f2a79d1d5011",
"md5": "9e3178783bc8b5117262bd070cb33f24",
"sha256": "f2253a8ddf171f775e26d5dc50a9fa85b957bc1ab81264dcce800e239222e21d"
},
"downloads": -1,
"filename": "beansp-2.25.0.tar.gz",
"has_sig": false,
"md5_digest": "9e3178783bc8b5117262bd070cb33f24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 1935746,
"upload_time": "2024-03-16T05:06:07",
"upload_time_iso_8601": "2024-03-16T05:06:07.139076Z",
"url": "https://files.pythonhosted.org/packages/3c/d1/769ec4f7b4beb38f844ca22b48cc17fd12cd3150c9c03457f2a79d1d5011/beansp-2.25.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 05:06:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adellej",
"github_project": "beans",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "emcee",
"specs": [
[
">=",
"3.0"
]
]
},
{
"name": "h5py",
"specs": [
[
">=",
"2.10.0"
]
]
},
{
"name": "pySettle",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "corner",
"specs": []
},
{
"name": "astropy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "tables",
"specs": []
},
{
"name": "chainconsumer",
"specs": [
[
"<=",
"0.34.0"
]
]
},
{
"name": "pytest",
"specs": []
},
{
"name": "sphinx_rtd_theme",
"specs": []
}
],
"tox": true,
"lcname": "beansp"
}
JSON
