CHANGELOG.md

@@ -5,9 +5,18 @@
 ### Added
 -
 
+### Changed
+-
+
+### Removed
+-
+
+## [0.4.0] 2019-02-15
+
 ### Changed
 - Fixed an accidental addition of astropy as a first-class dependency and added a check for missing dependencies to the C.I.
 - Fixed a bug in the "create-your-own-time-domain-model" example
+- Added citation guide to the readme
 
 ## [0.3.6] 2019-02-10
 

README.rst

 |pipeline status| |coverage report| |pypi| |conda| |version|
 
+=====
 Bilby
 =====
 
@@ -23,6 +24,46 @@ help in creating a merge request, see `this page
 <https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html>`__ or contact
 us directly. For advice on contributing, see `this help page <https://git.ligo.org/lscsoft/bilby/blob/master/CONTRIBUTING.md>`__.
 
+
+--------------
+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
+as requested in their associated documentation.
+
+**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>`__
+* `PyMC3 <https://github.com/pymc-devs/pymc3>`_
+
+
+**Gravitational-wave tools**
+
+* `gwpy <https://github.com/gwpy/gwpy>`__
+* `lalsuite <https://git.ligo.org/lscsoft/lalsuite>`__
+* `astropy <https://github.com/astropy/astropy>`__
+
+**Plotting**
+
+* `corner <https://github.com/dfm/corner.py>`__ for generating corner plot
+* `matplotlib <https://github.com/matplotlib/matplotlib>`__ for general plotting routines
+
+
 .. |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

containers/Singularity.0.4.0

+Bootstrap: docker
+From: bilbydev/bilby-test-suite-python37
+
+%help
+A singularity container for running bilby scripts. To use, simply execute the
+container, providing the bilby_script and any additional arguments. E.g.,
+
+./name_of_this_container.simg run_script.py
+
+%post
+export PATH="/opt/conda/bin:$PATH"
+pip install pandas==0.23  # Tempory fix for issue with saving h5 files
+pip install bilby==0.4.0
+
+%runscript
+exec /opt/conda/bin/python "$@"

setup.py

@@ -57,7 +57,7 @@ def readfile(filename):
     return filecontents
 
 
-VERSION = '0.3.6'
+VERSION = '0.4.0'
 version_file = write_version_file(VERSION)
 long_description = get_long_description()