forked from AOtools/aotools
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
migrated readme to restructured text for pypi
- Loading branch information
Matthew Townson
committed
Oct 17, 2018
1 parent
321e0cc
commit a931530
Showing
2 changed files
with
59 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
AOtools | ||
======= | ||
|
||
Useful tools for Adaptive Optics analysis for the Python Programming Language | ||
|
||
.. image:: https://travis-ci.org/AOtools/aotools.svg?branch=master | ||
:target: https://travis-ci.org/AOtools/aotools | ||
|
||
.. image:: https://ci.appveyor.com/api/projects/status/hru9gl4jekcwtm6l/branch/master?svg=true | ||
:target: https://ci.appveyor.com/project/Soapy/aotools/branch/master | ||
|
||
.. image:: https://codecov.io/gh/AOtools/aotools/branch/master/graph/badge.svg | ||
:target: https://codecov.io/gh/AOtools/aotools | ||
|
||
.. image:: http://readthedocs.org/projects/aotools/badge/?version=latest | ||
:target: http://aotools.readthedocs.org/en/latest/?badge=latest | ||
|
||
|
||
Required libraries | ||
------------------ | ||
|
||
.. code-block:: python | ||
python | ||
SciPy | ||
NumPy | ||
matplotlib | ||
Installation | ||
------------ | ||
|
||
As everything is just pure python, you don't really need to "install" at all. To be able to use the tools from anywhere on your system, | ||
add the ``aotools`` directory to your ``PYTHONTPATH``. | ||
Alternatively you can use one of the methods below. | ||
|
||
Pip | ||
+++ | ||
|
||
AOtools can be installed using pip: | ||
|
||
.. code-block:: python | ||
pip install aotools | ||
(which may require admin or root privileges) | ||
|
||
From Source | ||
+++++++++++ | ||
Alternatively, to install the tools to your system python distribution from source, run: | ||
|
||
.. code-block:: python | ||
python setup.py install | ||
(which may require admin or root privileges) from the ``aotools`` directory. | ||
|
||
Documentation | ||
+++++++++++++ | ||
Full documentation is hosted by `Read the Docs <http://aotools.readthedocs.io/en/stable/>`_ |