command line utility

This program will prepare the photometry on individual stars by doing all the operations which requires the full-size FFI images, like the following:

  • Estimating sky background for all images.

  • Estimating spacecraft jitter.

  • Creating average image.

  • Restructuring data into HDF5 files for efficient I/O operations.

The program can simply be run like the following, which will create a number of HDF5 files in the TESSPHOT_INPUT directory.

>>> python

You can also get a full list of the options by calling the program with:

>>> python --help

The program internally calls the function photometry.prepare.prepare_photometry() with the given parameters.

Code author: Rasmus Handberg <>

Command help

usage: [-h] [-d] [-q] [--sector SECTOR]
                                 [--camera {1,2,3,4}] [--ccd {1,2,3,4}]

Run TESS Photometry pipeline on single star.

positional arguments:
  input_folder        TESSPhot input directory to create HDF5 files in.

optional arguments:
  -h, --help          show this help message and exit
  -d, --debug         Print debug messages.
  -q, --quiet         Only report warnings and errors.

Filter which targets to include:
  --sector SECTOR     TESS Sector. Default is to run all sectors.
  --camera {1,2,3,4}  TESS Camera. Default is to run all cameras.
  --ccd {1,2,3,4}     TESS CCD. Default is to run all CCDs.