gPipeline API

gPipeline.check_args(args)

Checks validity of command line arguments and, in some cases

modifies them a little bit.

Parameters:args (argparse.ArgumentParser Namespace) – The command-line arguments. Returns:argparse.ArgumentParser Namespace – The updated command-line arguments.

gPipeline.gpipeline(raw6file, scstfile, band, outbase, aspfile, ssdfile, nullout, retries=100)

Wrapper that calls the PhotonPipe method.

Parameters:

• raw6file (str) – Name of the raw6 file to use.
• scstfile (str) – Spacecraft state file to use.
• band (str) – Name of the band to use, either ‘FUV’ or ‘NUV’.
• outbase (str) – Base of the output file names.
• aspfile (str) – Name of aspect file to use.
• ssdfile (str) – Name of Stim Separation Data file to use.
• nullfile (str) – Name of output file to record NULL lines.
• retries (int) – Number of query retries to attempt before giving up.

gPipeline.setup_parser()

Defines command-line arguments.

Returns:argparse.ArgumentParser Namespace – The command-line arguments.