diff --git a/README.md b/README.md
deleted file mode 100644
index 9620d05ed2cc2e3db4429dd2897b4e32fad09649..0000000000000000000000000000000000000000
--- a/README.md
+++ /dev/null
@@ -1,34 +0,0 @@
-[](https://git.ligo.org/Monash/tupak/commits/master)
-[](
-https://monash.docs.ligo.org/tupak/htmlcov/)
-
-# Tupak
-
-Fulfilling all your gravitational wave dreams.
-
-* [Installation instructions](https://monash.docs.ligo.org/tupak/installation.html)
-* [Documentation](https://monash.docs.ligo.org/tupak/index.html).
-* [Issue tracker](https://git.ligo.org/Monash/tupak/issues)
-
-We encourage you to contribute to the development via a merge request (for help
-in creating a merge request, see [this
-page](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) or
-contact us directly.
-
-## Examples
-
-To get started with `tupak`, we have a few examples and tutorials:
-
-1. [Examples of injecting and recovering data](https://git.ligo.org/Monash/tupak/tree/master/examples/injection_examples)
- * [A basic tutorial](https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/basic_tutorial.py)
- * [Create your own source model](https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_source_model.py)
- * [Create your own time-domain source model](https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_time_domain_source_model.py)
- * [How to specify the prior](https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/how_to_specify_the_prior.py)
- * [Using a partially marginalized likelihood](https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/marginalized_likelihood.py)
-
-2. [Examples using open data](https://git.ligo.org/Monash/tupak/tree/master/examples/open_data_examples)
- * [Analysing the first Binary Black hole detection, GW150914](https://git.ligo.org/Monash/tupak/blob/master/examples/open_data_examples/GW150914.py)
-
-3. [Notebook-style tutorials](https://git.ligo.org/Monash/tupak/tree/master/examples/tutorials)
- * [Comparing different samplers](https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/compare_samplers.ipynb)
- * [Visualising the output](https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/visualising_the_results.ipynb)
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000000000000000000000000000000000000..332cbdd285cc010527c7ca643d9ae7a37f2e503a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,54 @@
+|pipeline status| |coverage report|
+
+Tupak
+=====
+
+Fulfilling all your gravitational wave dreams.
+
+- `Installation
+ instructions <https://monash.docs.ligo.org/tupak/installation.html>`__
+- `Documentation <https://monash.docs.ligo.org/tupak/index.html>`__.
+- `Issue tracker <https://git.ligo.org/Monash/tupak/issues>`__
+
+We encourage you to contribute to the development via a merge request. For
+help in creating a merge request, see `this page
+<https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html>`__ or contact
+us directly.
+
+Examples
+--------
+
+To get started with ``tupak``, we have a few examples and tutorials:
+
+1. `Examples of injecting and recovering
+ data <https://git.ligo.org/Monash/tupak/tree/master/examples/injection_examples>`__
+
+ - `A basic
+ tutorial <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/basic_tutorial.py>`__
+ - `Create your own source
+ model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_source_model.py>`__
+ - `Create your own time-domain source
+ model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_time_domain_source_model.py>`__
+ - `How to specify the
+ prior <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/how_to_specify_the_prior.py>`__
+ - `Using a partially marginalized
+ likelihood <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/marginalized_likelihood.py>`__
+
+2. `Examples using open
+ data <https://git.ligo.org/Monash/tupak/tree/master/examples/open_data_examples>`__
+
+ - `Analysing the first Binary Black hole detection,
+ GW150914 <https://git.ligo.org/Monash/tupak/blob/master/examples/open_data_examples/GW150914.py>`__
+
+3. `Notebook-style
+ tutorials <https://git.ligo.org/Monash/tupak/tree/master/examples/tutorials>`__
+
+ - `Comparing different
+ samplers <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/compare_samplers.ipynb>`__
+ - `Visualising the
+ output <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/visualising_the_results.ipynb>`__
+
+.. |pipeline status| image:: https://git.ligo.org/Monash/tupak/badges/master/pipeline.svg
+ :target: https://git.ligo.org/Monash/tupak/commits/master
+.. |coverage report| image:: https://monash.docs.ligo.org/tupak/coverage_badge.svg
+ :target: https://monash.docs.ligo.org/tupak/htmlcov/
diff --git a/docs/installation.txt b/docs/installation.txt
index ed0034def928f3db49b747c0103e245bf0c72b42..8e52d0134770ce190a1bed1c26891c2e2c699f53 100644
--- a/docs/installation.txt
+++ b/docs/installation.txt
@@ -2,14 +2,23 @@
Installation
============
+The lastes stable release of Tupak can be installed simply from
+
+.. code-block: console
+
+ $ pip install tupak
+
+If you would like to install the development version, see the instructions
+below.
+
+Install tupak from source
+-------------------------
+
:code:`tupak` is developed to work with both Python 2.7+ and Python 3+. In the
following, we assume you have a working python installation, `python pip
<https://packaging.python.org/tutorials/installing-packages/#use-pip-for-installing)>`_,
and `git <https://git-scm.com/>`_.
-Install tupak
--------------
-
Clone the repository, install the requirements, and then install the software:
.. code-block:: console
diff --git a/setup.py b/setup.py
index cfa2439c3ef3ebff138051a105bc5b1287621b3c..e5811cb1cbafe535e24eac8e8d3afe84de5723c8 100644
--- a/setup.py
+++ b/setup.py
@@ -2,6 +2,7 @@
from distutils.core import setup
import subprocess
+from os import path
# Write a version file containing the git hash and info
try:
@@ -22,13 +23,18 @@ with open('tupak/' + version_file, 'w+') as f:
f.write(status)
+here = path.abspath(path.dirname(__file__))
+with open(path.join(here, 'README.rst')) as f:
+ long_description = f.read()
+
setup(name='tupak',
description='The User friendly Parameter estimAtion Kode',
+ long_description=long_description,
url='https://git.ligo.org/Monash/tupak',
- author='Greg Ashton, Moritz Hübner, Paul Lasky, Colm Talbot',
+ author='Greg Ashton, Moritz Hubner, Paul Lasky, Colm Talbot',
author_email='paul.lasky@monash.edu',
license="MIT",
- version='0.1',
+ version='0.1.3',
packages=['tupak', 'tupak.core', 'tupak.gw'],
package_dir={'tupak': 'tupak'},
package_data={'tupak.gw': ['prior_files/*', 'noise_curves/*.txt'],