Merge pull request #417 from mj-will/update-bilby-example-doc

Update bilby-related docs

README.md

@@ -34,7 +34,22 @@ By default the version of PyTorch will not necessarily match the drivers on your
 
 ### 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`
+As of ``bilby`` version 2.3.0, the recommended way to use ``nessai`` is via the [``nessai-bilby`` sampler plugin](https://github.com/bilby-dev/nessai-bilby).
+This can be installed via either ``conda`` or ``pip`` and provides the most
+up-to-date interface for ``nessai``.
+This includes support for the importance nested sampler (``inessai``).
+
+It can be installed using either
+
+```console
+pip install nessai-bilby
+```
+
+or
+
+```console
+conda install -c conda-forge nessai-bilby
+```
 
 See the examples included with ``nessai`` for how to run ``nessai`` via ``bilby``.
 

docs/bilby-example.rst

@@ -2,7 +2,12 @@
 Bilby example
 =============
 
-``nessai`` can be used like any of the other samplers in ``bilby`` and the full range of settings are available. The following example mirrors the :doc:`Gaussian example<gaussian-example>` but using ``bilby``.
+``nessai`` can be used like any of the other samplers in ``bilby`` and the full range of settings are available.
+The following example mirrors the :doc:`Gaussian example<gaussian-example>` but using ``bilby``.
+
+.. note::
+
+    As of ``bilby`` v2.3.0, the recommended way to use ``nessai`` is via the ``nessai-bilby` plugin, see :ref:`nessai-bilby`.
 
 Code
 ====

docs/installation.rst

@@ -22,6 +22,8 @@ This will install the dependencies needed but the version of PyTorch will not
 necessarily be the correct version for your system.
 
 
+.. _nessai-bilby:
+
 Using nessai with bilby
 =======================