lightspeedpy documentation

Lightspeedpy is a data reduction library for the proto-Lightspeed instrument. It is capable of processing bias, darks, and flats, manipulating data files, and performing more complex tasks such as generating light curves.

Once installed, lightspeedpy can be imported as a Python library and its tools can be used programmatically. Alternatively, lightspeedpy can be used as a command line tool.

Please review the below pages for how to install or contribute to lightspeedpy

• Installing Lightspeedpy
• How to contribute to Lightspeedpy

How do I use the command line interface (CLI)

A CLI call to lightspeedpy takes the form

python -m lightspeedpy.TOOL_NAME ARGUMENTS

The list of available tools is accessible through lightspeedpy’s help menu. To see it, run python -m lightspeedpy -h.

To access the documentation of a specific tool, run python -m lightspeedpy.TOOL_NAME -h. This will tell you what the tool does and how to provide arguments to the tool.

How do I use the application programming interface (API)

The lightspeedpy API can be accessed by importing lightspeedpy as a Python module. All the command line tools of lightspeedpy are available there as python functions. This API is particularly useful if you wish to test adding your own tools to lightspeedpy, or perform complex tasks.

The API is documented here:

• Lightspeedpy API
  • DataSet
  • Ephemeris
  • Frame
  • PixelProperties
  • Region
  • add_dataset_args()
  • get_dataset()
  • image subpackage
  • cube subpackage
  • lc subpackage