Installation

We recommend that you install the latest version of Anaconda Python 3.x on your system before installing sbpy. Make sure that Anaconda Python is your default Python (this will be asked during the installation process).

Requirements

sbpy has the following requirements that will be automatically taken care of with installation using pip:

  • Python 3.6 or later

  • numpy 1.13.0 or later

  • pytest 3.1 or later

  • astropy

  • astroquery 0.3.9.dev5089 or later: For retrieval of online data, e.g., ephemerides and orbits.

  • scipy: For numerical integrations in sbpy.activity.gas and sbpy.photometry, among others.

  • synphot 0.1.3 or later: For calibration with respect to the Sun and Vega, filtering spectra through bandpasses.

  • ginga and photutils: To interactively enhance images of comets with the CometaryEnhancement Ginga plugin.

The following packages will have to be installed manually, if the user wants to use them:

Using pip

The latest stable version of sbpy can be installed with

$ pip install sbpy

The latest development version of sbpy can be easily installed using

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

Using GitHub

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 using

$ git clone https://github.com/NASA-Planetary-Science/sbpy.git

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

$ 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