Installation

Requirements

Lightkurve has the following requirements, all of which tend to be available by default in a modern installation of Python:

  • Python: 2.7, 3.5, 3.6 or later.
  • Astropy: 1.3 or later.
  • Numpy: 1.11 or later.
  • Scipy: 0.19 or later.
  • Matplotlib: 1.5.3 or later.
  • Astroquery 0.3.7 or later.

Optional dependencies:

  • Pandas: 0.20 or later.
  • Bokeh: 1.0 or later.

We recommend using the Anaconda Python distribution, which will install Python alongside its most common scientific packages, including all those listed above. If you install lightkurve using pip or conda as explained below, any missing dependencies will be installed automatically.

Installing lightkurve

Using pip

The easiest way to install or upgrade lightkurve is with pip, which is standard part of most Python distributions. To install lightkurve, simply run the following command on a terminal window:

$ pip install lightkurve --upgrade

The --upgrade flag is optional, but recommended if you already have lightkurve installed and want to upgrade to the latest version.

Note

If you get a PermissionError this means that you do not have the required administrative access to install new packages to your Python installation. In this case you may consider using the --user option to install the package into your home directory. You can read more about how to do this in the pip documentation.

Using conda

Alternatively, you can use the conda package manager, which is part of the Anaconda Python distribution. With conda installed, you can run the following command on a terminal window:

$ conda install --channel conda-forge lightkurve

Installing the development version

If you want to experiment with the latest development version of lightkurve, you can install it straight from the master branch on GitHub:

$ git clone https://github.com/KeplerGO/lightkurve.git
$ cd lightkurve
$ pip install -e .

This is recommended for anyone who wants to edit the source code. Please see our guide on contributing to lightkurve for additional instructions.