Skip to content
Snippets Groups Projects
Commit 3259492f authored by Gregory Ashton's avatar Gregory Ashton
Browse files

Improvements to pip page

- Convert markdown readme to rst
- Add pip install entry to installation instructions
parent 2eaea236
No related branches found
No related tags found
No related merge requests found
Pipeline #
[![pipeline status](https://git.ligo.org/Monash/tupak/badges/master/pipeline.svg)](https://git.ligo.org/Monash/tupak/commits/master)
[![coverage report](https://monash.docs.ligo.org/tupak/coverage_badge.svg)](
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)
|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/
......@@ -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
......
......@@ -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'],
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment