[](https://doi.org/10.5281/zenodo.4550693)
[](https://pypi.org/project/nessai/)
[](https://anaconda.org/conda-forge/nessai)
[](https://nessai.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/mj-will/nessai)
# nessai: Nested Sampling with Artificial Intelligence
``nessai`` (/ˈnɛsi/): Nested Sampling with Artificial Intelligence
``nessai`` is a nested sampling algorithm for Bayesian Inference that incorporates normalising flows. It is designed for applications where the Bayesian likelihood is computationally expensive.
## Installation
``nessai`` can be installed using ``pip``:
```console
pip install nessai
```
or via ``conda``
```console
conda install -c conda-forge -c pytorch nessai
```
### PyTorch
By default the version of PyTorch will not necessarily match the drivers on your system, to install a different version with the correct CUDA support see the PyTorch homepage for instructions: https://pytorch.org/.
### Using ``bilby``
As of `bilby` version 1.1.0, ``nessai`` is now supported by default but it is still an optional requirement. See the [``bilby`` documentation](https://lscsoft.docs.ligo.org/bilby/index.html) for installation instructions for `bilby`
See the examples included with ``nessai`` for how to run ``nessai`` via ``bilby``.
## Documentation
Documentation is available at: [nessai.readthedocs.io](https://nessai.readthedocs.io/)
## Contributing
Please see the guidelines [here](https://github.com/mj-will/nessai/blob/master/CONTRIBUTING.md).
## Acknowledgements
The core nested sampling code, model design and code for computing the posterior in ``nessai`` was based on [`cpnest`](https://github.com/johnveitch/cpnest) with permission from the authors.
The normalising flows implemented in ``nessai`` are all either directly imported from [`nflows`](https://github.com/bayesiains/nflows/tree/master/nflows) or heavily based on it.
Other code snippets that draw on existing code reference the source in their corresponding doc-strings.
The authors also thank Christian Chapman-Bird, Laurence Datrier, Fergus Hayes, Jethro Linley and Simon Tait for their feedback and help finding bugs in ``nessai``.
## Citing
If you find ``nessai`` useful in your work please cite the DOI for this code and our papers:
```bibtex
@software{nessai,
author = {Michael J. Williams},
title = {nessai: Nested Sampling with Artificial Intelligence},
month = feb,
year = 2021,
publisher = {Zenodo},
version = {latest},
doi = {10.5281/zenodo.4550693},
url = {https://doi.org/10.5281/zenodo.4550693}
}
@article{Williams:2021qyt,
author = "Williams, Michael J. and Veitch, John and Messenger, Chris",
title = "{Nested sampling with normalizing flows for gravitational-wave inference}",
eprint = "2102.11056",
archivePrefix = "arXiv",
primaryClass = "gr-qc",
doi = "10.1103/PhysRevD.103.103006",
journal = "Phys. Rev. D",
volume = "103",
number = "10",
pages = "103006",
year = "2021"
}
@article{Williams:2023ppp,
author = "Williams, Michael J. and Veitch, John and Messenger, Chris",
title = "{Importance nested sampling with normalising flows}",
eprint = "2302.08526",
archivePrefix = "arXiv",
primaryClass = "astro-ph.IM",
reportNumber = "LIGO-P2200283",
month = "2",
year = "2023"
}
```
Raw data
{
"_id": null,
"home_page": "",
"name": "nessai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nested sampling,normalizing flows,machine learning",
"author": "",
"author_email": "\"Michael J. Williams\" <michaeljw1@googlemail.com>",
"download_url": "https://files.pythonhosted.org/packages/bf/ff/a82f07260633040b942b308374f548efa18d543799acde97ff11911b7f99/nessai-0.11.0.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.4550693)\n[](https://pypi.org/project/nessai/)\n[](https://anaconda.org/conda-forge/nessai)\n[](https://nessai.readthedocs.io/en/latest/?badge=latest)\n\n\n\n[](https://codecov.io/gh/mj-will/nessai)\n\n# nessai: Nested Sampling with Artificial Intelligence\n\n``nessai`` (/\u02c8n\u025bsi/): Nested Sampling with Artificial Intelligence\n\n``nessai`` is a nested sampling algorithm for Bayesian Inference that incorporates normalising flows. It is designed for applications where the Bayesian likelihood is computationally expensive.\n\n## Installation\n\n``nessai`` can be installed using ``pip``:\n\n```console\npip install nessai\n```\n\nor via ``conda``\n\n```console\nconda install -c conda-forge -c pytorch nessai\n```\n\n### PyTorch\n\nBy default the version of PyTorch will not necessarily match the drivers on your system, to install a different version with the correct CUDA support see the PyTorch homepage for instructions: https://pytorch.org/.\n\n### Using ``bilby``\n\nAs of `bilby` version 1.1.0, ``nessai`` is now supported by default but it is still an optional requirement. See the [``bilby`` documentation](https://lscsoft.docs.ligo.org/bilby/index.html) for installation instructions for `bilby`\n\nSee the examples included with ``nessai`` for how to run ``nessai`` via ``bilby``.\n\n## Documentation\n\nDocumentation is available at: [nessai.readthedocs.io](https://nessai.readthedocs.io/)\n\n\n## Contributing\n\nPlease see the guidelines [here](https://github.com/mj-will/nessai/blob/master/CONTRIBUTING.md).\n\n\n## Acknowledgements\n\nThe core nested sampling code, model design and code for computing the posterior in ``nessai`` was based on [`cpnest`](https://github.com/johnveitch/cpnest) with permission from the authors.\n\nThe normalising flows implemented in ``nessai`` are all either directly imported from [`nflows`](https://github.com/bayesiains/nflows/tree/master/nflows) or heavily based on it.\n\nOther code snippets that draw on existing code reference the source in their corresponding doc-strings.\n\nThe authors also thank Christian Chapman-Bird, Laurence Datrier, Fergus Hayes, Jethro Linley and Simon Tait for their feedback and help finding bugs in ``nessai``.\n\n## Citing\n\nIf you find ``nessai`` useful in your work please cite the DOI for this code and our papers:\n\n```bibtex\n@software{nessai,\n author = {Michael J. Williams},\n title = {nessai: Nested Sampling with Artificial Intelligence},\n month = feb,\n year = 2021,\n publisher = {Zenodo},\n version = {latest},\n doi = {10.5281/zenodo.4550693},\n url = {https://doi.org/10.5281/zenodo.4550693}\n}\n\n@article{Williams:2021qyt,\n author = \"Williams, Michael J. and Veitch, John and Messenger, Chris\",\n title = \"{Nested sampling with normalizing flows for gravitational-wave inference}\",\n eprint = \"2102.11056\",\n archivePrefix = \"arXiv\",\n primaryClass = \"gr-qc\",\n doi = \"10.1103/PhysRevD.103.103006\",\n journal = \"Phys. Rev. D\",\n volume = \"103\",\n number = \"10\",\n pages = \"103006\",\n year = \"2021\"\n}\n\n@article{Williams:2023ppp,\n author = \"Williams, Michael J. and Veitch, John and Messenger, Chris\",\n title = \"{Importance nested sampling with normalising flows}\",\n eprint = \"2302.08526\",\n archivePrefix = \"arXiv\",\n primaryClass = \"astro-ph.IM\",\n reportNumber = \"LIGO-P2200283\",\n month = \"2\",\n year = \"2023\"\n}\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Nessai: Nested Sampling with Artificial Intelligence",
"version": "0.11.0",
"project_urls": {
"Documentation": "https://nessai.readthedocs.io/",
"Homepage": "https://github.com/mj-will/nessai"
},
"split_keywords": [
"nested sampling",
"normalizing flows",
"machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03f7f781081ff8e16ebeb4c074c716820943d2c266a40f405ddfdf794506b7d3",
"md5": "e4994bc49e94ea3425586a3ec78e34b0",
"sha256": "6317a431168c760d0a7874c19e629180f1466ea514c138f48a8f62ebedf57ec9"
},
"downloads": -1,
"filename": "nessai-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4994bc49e94ea3425586a3ec78e34b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 155737,
"upload_time": "2023-11-30T09:43:26",
"upload_time_iso_8601": "2023-11-30T09:43:26.778628Z",
"url": "https://files.pythonhosted.org/packages/03/f7/f781081ff8e16ebeb4c074c716820943d2c266a40f405ddfdf794506b7d3/nessai-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfffa82f07260633040b942b308374f548efa18d543799acde97ff11911b7f99",
"md5": "0342699e32e75160d7eca75c098dc5fe",
"sha256": "b1b1d03f3093dd0a0700fa005fd3e556a9bcdd2349f84b33ab45eec184142342"
},
"downloads": -1,
"filename": "nessai-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "0342699e32e75160d7eca75c098dc5fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 573964,
"upload_time": "2023-11-30T09:43:29",
"upload_time_iso_8601": "2023-11-30T09:43:29.123465Z",
"url": "https://files.pythonhosted.org/packages/bf/ff/a82f07260633040b942b308374f548efa18d543799acde97ff11911b7f99/nessai-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-30 09:43:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mj-will",
"github_project": "nessai",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "nessai"
}
JSON
