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

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

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

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

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

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

17
- Join our `Slack workspace <https://bilby-code.slack.com/>`__ (you may need to email the support desk to request an invite)
Gregory Ashton's avatar
Gregory Ashton committed
18
- Email our support desk: contact+lscsoft-bilby-1846-issue-@support.ligo.org
Gregory Ashton's avatar
Gregory Ashton committed
19
- 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
20
- For www.git.ligo.org users, submit issues directly through `the issue tracker <https://git.ligo.org/lscsoft/bilby/issues>`__
21
- For www.chat.ligo.org users, join the `#bilby-help <https://chat.ligo.org/ligo/channels/bilby-help>`__ or `#bilby-devel <https://chat.ligo.org/ligo/channels/bilby-devel>`__ channels
Gregory Ashton's avatar
Gregory Ashton committed
22
23

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
24
25
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
26
us directly. For advice on contributing, see `the contributing guide <https://git.ligo.org/lscsoft/bilby/blob/master/CONTRIBUTING.md>`__.
Gregory Ashton's avatar
Gregory Ashton committed
27

Gregory Ashton's avatar
Gregory Ashton committed
28

Gregory Ashton's avatar
Gregory Ashton committed
29
--------------
Gregory Ashton's avatar
Gregory Ashton committed
30
31
32
33
34
35
36
37
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>`__
Gregory Ashton's avatar
Gregory Ashton committed
38
39
40
41
42
43
* `Bayesian inference for compact binary coalescences with BILBY: validation and application to the first LIGO-Virgo gravitational-wave transient catalogue <https://ui.adsabs.harvard.edu/abs/2020MNRAS.499.3295R/abstract>`__

The first of these papers introduces the software, while the second introduces advances in the sampling approaches and validation of the software.
If you use the :code:`bilby_mcmc` sampler, please additionally cite

* `BILBY-MCMC: an MCMC sampler for gravitational-wave inference <https://ui.adsabs.harvard.edu/abs/2021MNRAS.507.2037A/abstract>`__
Gregory Ashton's avatar
Gregory Ashton committed
44
45

Additionally, :code:`bilby` builds on a number of open-source packages. If you
Gregory Ashton's avatar
Gregory Ashton committed
46
47
make use of this functionality in your publications, we recommend you cite them
as requested in their associated documentation.
Gregory Ashton's avatar
Gregory Ashton committed
48

Gregory Ashton's avatar
Gregory Ashton committed
49
**Samplers**
Gregory Ashton's avatar
Gregory Ashton committed
50
51
52
53
54
55
56
57

* `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>`__
58
* `pypolychord <https://github.com/PolyChord/PolyChordLite>`__
Gregory Ashton's avatar
Gregory Ashton committed
59
* `PyMC3 <https://github.com/pymc-devs/pymc3>`_
Gregory Ashton's avatar
Gregory Ashton committed
60
61


Gregory Ashton's avatar
Gregory Ashton committed
62
**Gravitational-wave tools**
Gregory Ashton's avatar
Gregory Ashton committed
63
64
65
66
67

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

Gregory Ashton's avatar
Gregory Ashton committed
68
**Plotting**
Gregory Ashton's avatar
Gregory Ashton committed
69
70
71
72
73

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


74
75
76
77
.. |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
78
79
.. |pypi| image:: https://badge.fury.io/py/bilby.svg
   :target: https://pypi.org/project/bilby/
80
81
.. |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
82
.. |version| image:: https://img.shields.io/pypi/pyversions/bilby.svg
Gregory Ashton's avatar
Gregory Ashton committed
83
   :target: https://pypi.org/project/bilby/