1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
|
.. include:: references.txt
.. _installation:
************
Installation
************
Requirements
============
**astroplan** works on Linux, Mac OS X and Windows.
It requires Python 3.7+ as well as numpy, astropy, pytz, and six.
Additional features are available when you install `Matplotlib`_
and `astroquery`_.
First-time Python users may want to consider an all-in-one Python installation
package, such as the `Anaconda Python Distribution
<http://continuum.io/downloads>`_ which provides all of the above dependencies.
Installation
============
You can install the stable version of astroplan from PyPI with::
pip install astroplan
or from anaconda::
conda install -c conda-forge astroplan
Alternatively, you can install the latest developer version of astroplan by
cloning the git repository::
git clone https://github.com/astropy/astroplan
...then installing the package with::
cd astroplan
pip install .
Testing
=======
If you want to check that all the tests are running correctly with your Python
configuration, run the following from the command line::
tox -e test
If there are no errors, you are good to go!
.. note::
If you want to run the tests that access the internet, you'll need to
replace the last line above with ``tox -e test -- --remote-data`` and
have an active connection to the internet. Also, if you want the tests
that check plotting to work, you need `Matplotlib`_ and `pytest-mpl`_.
More
====
astroplan follows `astropy <https://astropy.org>`__'s guidelines for affiliated packages--installation
and testing for the two are quite similar! Please see astropy's
`installation page <http://astropy.readthedocs.io/en/latest/install.html>`_
for more information.
|