********************
Installing astropath
********************

This document describes how to install the `astropath`
repository.

Installing Dependencies
=======================

We have and will continue to keep the number of dependencies low.
There are a few standard packages that must be installed
and little more.

In general, we recommend that you use Anaconda or
*pip* for the majority of these installations.

Detailed installation instructions are presented below:

Dependencies
------------

astropath depends on the following list of Python packages.

We recommend that you use `Anaconda <https://www.continuum.io/downloads/>`_
to install and/or update these packages.

* `python <http://www.python.org/>`_ versions 3.8 or later
* `numpy <http://www.numpy.org/>`_ version 1.18 or later
* `astropy <http://www.astropy.org/>`_ version 4.3 or later
* `scipy <http://www.scipy.org/>`_ version 1.4 or later
* `pandas <https://pandas.pydata.org/>`_ version 0.25 or later
* `photutils <https://photutils.readthedocs.io/en/stable/>`_  version 1.0.1 or later
* `healpy <https://github.com/healpy/healpy>`_  version 1.14 or later
* `astropy-healpix <https://pypi.org/project/astropy-healpix/>`_  version 0.5 or later
* `ligo.skymap <https://lscsoft.docs.ligo.org/ligo.skymap/index.html>`_  version 0.5 or later

If you are using Anaconda, you can check the presence of these packages with::

	conda list "^python|numpy|astropy|scipy|pandas"

If the packages have been installed, this command should print
out all the packages and their version numbers.

Installing astropath
====================

Presently, you must download the code from github::

	# Go to the directory where you would like to install astropath
	git clone https://github.com/FRBs/astropath.git

From there, you can build and install with::

	cd astropath
	python setup.py install  # or use develop


This should install the package and any related scripts.
Make sure that your PATH includes the standard
location for Python scripts (e.g. ~/anaconda/bin)