README.rst 1.58 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 10 11
For online material to help you get started:

-  `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 15 16 17 18 19
If you need help, find an issue, or just have a question/suggestion:

-  `Join our Slack workspace <https://bilby-code.slack.com/>`__
-  `For www.git.ligo.org users, submit issues directly through the issue tracker <https://git.ligo.org/lscsoft/bilby/issues>`__

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
20 21
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
22
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
23

24 25 26 27
.. |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
28 29
.. |pypi| image:: https://badge.fury.io/py/bilby.svg
   :target: https://pypi.org/project/bilby/
30 31
.. |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
32
.. |version| image:: https://img.shields.io/pypi/pyversions/bilby.svg
Gregory Ashton's avatar
Gregory Ashton committed
33
   :target: https://pypi.org/project/bilby/