Commit 855c4d89 authored by Daniel Williams's avatar Daniel Williams
Browse files

Merge branch 'master' of github.com:transientlunatic/minke

parents 4fcf46e9 72676e7c
Loading
Loading
Loading
Loading

.coveragerc

0 → 100644
+9 −0
Original line number Diff line number Diff line
[run]
source = minke
omit =
    */python?.?/*
    */lib-python/?.?/*.py
    */lib_pypy/_*.py
    */site-packages/ordereddict.py
    */site-packages/nose/*
    */unittest2/*
+11 −7
Original line number Diff line number Diff line
@@ -2,17 +2,21 @@
Minke: The Burst MDC Factory
===============================

.. image:: https://img.shields.io/pypi/v/minki.svg
        :target: https://pypi.python.org/pypi/minki
.. image:: https://img.shields.io/pypi/v/minke.svg
        :target: https://pypi.python.org/pypi/minke

.. image:: https://img.shields.io/travis/transientlunatic/minki.svg
        :target: https://travis-ci.org/transientlunatic/minki
.. image:: https://img.shields.io/travis/transientlunatic/minke.svg
        :target: https://travis-ci.org/transientlunatic/minke

.. image:: https://readthedocs.org/projects/minki/badge/?version=latest
        :target: https://readthedocs.org/projects/minki/?badge=latest
.. image:: https://readthedocs.org/projects/minke/badge/?version=latest
        :target: https://readthedocs.org/projects/minke/?badge=latest
        :alt: Documentation Status

.. image:: ./minke.png
.. image:: https://coveralls.io/repos/github/transientlunatic/minke/badge.svg?branch=master
	   :target: https://coveralls.io/github/transientlunatic/minke?branch=master
	   :alt: Coverage status
	      
.. image:: https://code.daniel-williams.co.uk/minke/minke.png
	   :alt: Project Minke Logo

Minke is a Python package to produce Mock Data Challenge data sets for LIGO interferometers.
+26 −1
Original line number Diff line number Diff line
@@ -22,7 +22,18 @@ the moment you'll need to have the `simburst-rel` branch of it
installed specifically, so that you can make supernova (and other
numerical relativity) injections.

Contents:
If you're looking to make MDC injection sets for a burst analysis, but
you aren't concerned with contributing new code take a look at the
User Guide. If you need a feature which isn't currently implemented
then please have a look at the "Contributing" section of the Developer
Guide.

The Minke framework aims to be flexible, and easily extended to
include new waveform morphologies, and signal distributions, so if you
find something lacking feel free to make a pull request!

User Guide
==========

.. toctree::
   :maxdepth: 2
@@ -30,7 +41,21 @@ Contents:
   readme
   installation
   usage

Developer Guide
===============

.. toctree::
   :maxdepth: 2

   contributing

Credits and Information
=======================

.. toctree::
   :maxdepth: 2
	   
   authors
   history