Installation

Requirements

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

  • Python 3.7 or later

  • numpy 1.17.0 or later

  • astropy 4.0 or later

  • astroquery 0.4.5 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 1.0.0 or later: For calibration with respect to the Sun and Vega, filtering spectra through bandpasses.

Optional dependencies

  • Python extensions for oorb: For orbit transformations (oo_transform) and propagations (oo_propagate), as well as ephemerides calculations (from_oo).

  • pyradex: For non-LTE production rate calculation related to cometary activity (NonLTE).

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

Using pip

The latest stable version of sbpy can be installed with:

$ pip install sbpy

Most optional dependencies may be installed via:

$ pip install sbpy[all]

oorb and pyradex are left for the user to install manually.

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

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

Using conda

The latest stable version of sbpy can be installed with Anaconda via the conda-forge channel:

$ conda install sbpy --channel=conda-forge

If you do not have the conda-forge channel available, add it and re-run the installation command:

$ conda config --add channels conda-forge
$ conda install sbpy --channel=conda-forge

Using Git+Pip

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:

$ pip install .

As above, to install optional dependencies, instead use pip install .[all].

If you plan to work on the code and always want to use the latest version of your code, we recommend installing in “editable” mode with the optional dependences and the testing dependencies:

$ pip install -e .[all,test]