recipes – Builtin recipes

Module implementing the recipes entry points

libvhc.recipes.RECIPE_FILE = 'v_recipe.txt'

Name of the recipe file

libvhc.recipes.get_recipe(path, log)

Load and try to read the recipe name or infer it from the files in path

Parameters:

path : string

path where to look for files if the recipe file does not exists

log : logging.Logger

logger to use

libvhc.recipes.recipe_file(path)

Return the name of the recipe file

Parameters:

path : string

path where the recipe file leaves

Returns:

string

name of the recipe file

libvhc.recipes.make_recipe(path, log)

Infer the recipe name of the first virus fits file found.

If the recipe is known, write it to the ‘v_recipe.txt’ file.

Parameters:

path : string

path provided to the vhc executable.

log : logging.Logger

logger to use

Returns:

recipe : string

recipe name

libvhc.recipes.recipe_protopype(name)

Signature for a function used to register a recipe.

Parameters:

name : string

name under which the recipe is advertised

Returns:

string

file name template to use to collect all the relevant file or to guess the recipe name from the files; e.g. for the flat recipe [0-9]*flt.fits is returned

list of strings

list of default drivers to run for the recipe, if no v_driver.txt file is found; e.g. ['common:n_files', 'common:saturation']

libvhc.recipes.flat_recipe(name)

File names and drivers available for the flat recipe

libvhc.recipes.bias_recipe(name)

File names and drivers available for the bias recipe

libvhc.recipes.arc_recipe(name)

File names and drivers available for the arc recipe

libvhc.recipes.hetdex_dither_recipe(name)

File names and drivers available for the hetdex_dither recipe

libvhc.recipes.twilight_recipe(name)

File names and drivers available for the twilight recipe

libvhc.recipes.dark_recipe(name)

File names and drivers available for the dark recipe

libvhc.recipes.engineering_recipe(name)

File names and drivers available for the engineering recipe