README.rst 3.15 KB
Newer Older
1
|pipeline status| |coverage report| |pypi| |conda| |version|
Gregory Ashton's avatar
Gregory Ashton committed
2

Colm Talbot's avatar
Colm Talbot committed
3
Bilby
Gregory Ashton's avatar
Gregory Ashton committed
4 5
=====

6 7
A user-friendly Bayesian inference library.
Fulfilling all your Bayesian dreams.
Gregory Ashton's avatar
Gregory Ashton committed
8

Gregory Ashton's avatar
Gregory Ashton committed
9
Online material to help you get started:
Gregory Ashton's avatar
Gregory Ashton committed
10 11

-  `Installation instructions <https://lscsoft.docs.ligo.org/bilby/installation.html>`__
12
-  `Documentation <https://lscsoft.docs.ligo.org/bilby/index.html>`__
Gregory Ashton's avatar
Gregory Ashton committed
13

Gregory Ashton's avatar
Gregory Ashton committed
14
If you need help, find an issue, or just have a question/suggestion you can
Gregory Ashton's avatar
Gregory Ashton committed
15

Gregory Ashton's avatar
Gregory Ashton committed
16 17
- Email our support desk: contact+lscsoft-bilby-1846-issue-@support.ligo.org
- Join our `Slack workspace <https://bilby-code.slack.com/>`__
Gregory Ashton's avatar
Gregory Ashton committed
18
- Ask questions (or search through other users questions and answers) on `StackOverflow <https://stackoverflow.com/questions/tagged/bilby>`__ using the bilby tag
Gregory Ashton's avatar
Gregory Ashton committed
19
- For www.git.ligo.org users, submit issues directly through `the issue tracker <https://git.ligo.org/lscsoft/bilby/issues>`__
Gregory Ashton's avatar
Gregory Ashton committed
20 21

We encourage you to contribute to the development of bilby. This is done via a merge request.  For
Gregory Ashton's avatar
Gregory Ashton committed
22 23
help in creating a merge request, see `this page
<https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html>`__ or contact
Gregory Ashton's avatar
Gregory Ashton committed
24
us directly. For advice on contributing, see `this help page <https://git.ligo.org/lscsoft/bilby/blob/master/CONTRIBUTING.md>`__.
Gregory Ashton's avatar
Gregory Ashton committed
25

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

Citation guide
--------------

If you use :code:`bilby` in a scientific publication, please cite

* `Bilby: A user-friendly Bayesian inference library for gravitational-wave
  astronomy
  <https://ui.adsabs.harvard.edu/#abs/2018arXiv181102042A/abstract>`__

Additionally, :code:`bilby` builds on a number of open-source packages. If you
make use of this functionality in your publications, we recommend you cite them.

Bilby provides access to the following samplers:

* `dynesty <https://github.com/joshspeagle/dynesty>`__
* `nestle <https://github.com/kbarbary/nestle>`__
* `pymultinest <https://github.com/JohannesBuchner/PyMultiNest>`__
* `cpnest <https://github.com/johnveitch/cpnest>`__
* `emcee <https://github.com/dfm/emcee>`__
* `ptemcee <https://github.com/willvousden/ptemcee>`__
* `ptmcmcsampler <https://github.com/jellis18/PTMCMCSampler>`__
* `pypolychord <https://github.com/vhaasteren/pypolychord>`__


Bilby makes use of the following packages for gravitational-wave related tools:

* `gwpy <https://github.com/gwpy/gwpy>`__
* `lalsuite <https://git.ligo.org/lscsoft/lalsuite>`__
* `astropy <https://github.com/astropy/astropy>`__

Bilby makes use of the following packages for plotting:

* `corner <https://github.com/dfm/corner.py>`__ for generating corner plot
* `matplotlib <https://github.com/matplotlib/matplotlib>`__ for general plotting routines


63 64 65 66
.. |pipeline status| image:: https://git.ligo.org/lscsoft/bilby/badges/master/pipeline.svg
   :target: https://git.ligo.org/lscsoft/bilby/commits/master
.. |coverage report| image:: https://lscsoft.docs.ligo.org/bilby/coverage_badge.svg
   :target: https://lscsoft.docs.ligo.org/bilby/htmlcov/
Gregory Ashton's avatar
Gregory Ashton committed
67 68
.. |pypi| image:: https://badge.fury.io/py/bilby.svg
   :target: https://pypi.org/project/bilby/
69 70
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/bilby.svg
   :target: https://anaconda.org/conda-forge/bilby
Colm Talbot's avatar
Colm Talbot committed
71
.. |version| image:: https://img.shields.io/pypi/pyversions/bilby.svg
Gregory Ashton's avatar
Gregory Ashton committed
72
   :target: https://pypi.org/project/bilby/