Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
benbaror committed Feb 15, 2018
1 parent 575de90 commit 08ac5c5
Showing 1 changed file with 28 additions and 49 deletions.
77 changes: 28 additions & 49 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,53 @@
========
Overview
scRRpy
========

.. start-badges
.. list-table::
:stub-columns: 1

* - docs
- |docs|
* - tests
- | |travis| |appveyor| |requires|
| |codecov| |coveralls|
Scalar Resonant Relaxation around a massive black hole

.. |docs| image:: https://readthedocs.org/projects/scrrpy/badge/?style=flat
:target: https://readthedocs.org/projects/scrrpy
:alt: Documentation Status
.. start-badges
.. |travis| image:: https://travis-ci.org/benbaror/scRRpy.svg?branch=master
.. |travis| image:: https://travis-ci.org/benbaror/scrrpy.svg?branch=master
:alt: Travis-CI Build Status
:target: https://travis-ci.org/benbaror/scRRpy
:target: https://travis-ci.org/benbaror/scrrpy

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/benbaror/scrrpy?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/benbaror/scrrpy

.. |requires| image:: https://requires.io/github/benbaror/scRRpy/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/benbaror/scRRpy/requirements/?branch=master
.. |coveralls| image:: https://coveralls.io/repos/github/benbaror/scrrpy/badge.svg?branch=master
:target: https://coveralls.io/github/benbaror/scrrpy?branch=master

.. |codecov| image:: https://codecov.io/github/benbaror/scrrpy/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/benbaror/scrrpy
.. |coveralls| image:: https://coveralls.io/repos/github/benbaror/scRRpy/badge.svg?branch=master
:target: https://coveralls.io/github/benbaror/scRRpy?branch=master

.. |docs| image:: https://readthedocs.org/projects/scrrpy/badge/?style=flat
:target: https://readthedocs.org/projects/scrrpy
:alt: Documentation Status

.. |requires| image:: https://requires.io/github/benbaror/scrrpy/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/benbaror/scrrpy/requirements/?branch=master


.. end-badges
Calculation of Scalar Resonant Relaxation
* Free software: BSD license

Installation
============

PYTHON VERSIONS AND DEPENDENCIES
---------------------------------

``scRRpy`` supports both Python 3.5, and 3.6

This package requires:
* `Numpy <http://numpy.scipy.org/>`__
* `Scipy <http://www.scipy.org/>`__
* `Matplotlib <http://matplotlib.sourceforge.net/>`__
* `astropy <http://www.astropy.org/>`__
* `numba <https://numba.pydata.org/>`__
* `vegas <https://github.com/gplepage/vegas>`__


::

pip install scrrpy
Expand All @@ -53,27 +56,3 @@ Documentation
=============

https://scrrpy.readthedocs.io/

Development
===========

To run the all tests run::

tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::
:widths: 10 90
:stub-columns: 1

- - Windows
- ::

set PYTEST_ADDOPTS=--cov-append
tox

- - Other
- ::

PYTEST_ADDOPTS=--cov-append tox

0 comments on commit 08ac5c5

Please sign in to comment.