Installation¶

f3 is written in Python. It can be installed using pip with the command:

pip install f3

From Source¶

The source code can be downloaded from GitHub by running

git clone https://github.com/benmontet/f3.git

and then can be built by running

python setup.py install

in the root directory of the source tree.

Dependencies¶

In addition to a Python installation, there are a few other dependencies that are required to run f3:

mahotas will be automagically installed along with f3 by running setup.py (or through pip). As of June 5, 2017, the kplr version available on pip is not sufficient for running f3, you need a version dated June 11, 2016 or newer: the version on github linked above will be sufficient.

You will also need the Full Frame Images themselves, which are 44gb and not a part of the installation package. To get them, run

wget -r -nH -nd -np -R index.html -e robots=off https://archive.stsci.edu/pub/kepler/ffi/

f3 will by default look for these in a subdirectory from your working directory called “ffidata” but they can be placed anywhere.