Skip to content

Commit

Permalink
Merge 77e1aee into 7acf354
Browse files Browse the repository at this point in the history
  • Loading branch information
mommermi committed Sep 14, 2018
2 parents 7acf354 + 77e1aee commit 12984f3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
24 changes: 19 additions & 5 deletions docs/index.rst
@@ -1,3 +1,5 @@
.. doctest-skip-all
sbpy Documentation
==================

Expand Down Expand Up @@ -33,14 +35,26 @@ Installation
supported. We hence recommend that you install the latest version of
`Anaconda Python 3.x <https://www.anaconda.com/download/>`_ on your
system before installing `sbpy`. Make sure that Anaconda Python is
your default Python (this is asked during the installation process).
your default Python (this will be asked during the installation process).

Requirements
^^^^^^^^^^^^

Most requirements should be resolved during the installation process. However, we recommend to install the latest development version of `astroquery` using

>>> pip install git+https://github.com/astropy/astroquery.git

Also, if you want to use `pyoorb
<https://github.com/oorb/oorb/tree/master/python>`_, you will have to
install it using the instructions provided on that page.


Using pip
^^^^^^^^^

The latest development version of `sbpy` can be easily installed using

pip install git+https://github.com/NASA-Planetary-Science/sbpy.git
>>> pip install git+https://github.com/NASA-Planetary-Science/sbpy.git


Using GitHub
Expand All @@ -50,15 +64,15 @@ This way of installing `sbpy` is recommended if you plan to contribute
to the module. The current development version of `sbpy` can be
obtained from `GitHub <https://github.com/mommermi/sbpy>`_ using

git clone https://github.com/mommermi/sbpy.git
>>> git clone https://github.com/mommermi/sbpy.git

This will create a new directory (``sbpy/``). In this directory, run

python setup.py install --user
>>> python setup.py install --user

in order to use `sbpy` in your default Python environment. If you plan to work on the code and always want to use the latest version of your code, you can install it with

python setup.py develop --user
>>> python setup.py develop --user

Learning how to use `sbpy`
--------------------------
Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
@@ -1,6 +1,6 @@
numpy
numpy>=1.4.0
astropy-helpers
matplotlib
ads
synphot
astroquery
astroquery>=0.3.8

0 comments on commit 12984f3

Please sign in to comment.