PythonRecipe

class musered.PythonRecipe(output_dir=None, log_dir='.', temp_dir=None, **kwargs)

Bases: musered.recipes.recipe.BaseRecipe

Class for Python recipes.

Attributes Summary

DPR_TYPE	Type of data to process (DPR.TYPE).
calib_frames	Return the list of calibration frames.
default_params	Default parameters.
exclude_frames	Frames that must be excluded by default.
n_inputs_min	Minimum number of input files, as required by the DRS.
output_dir	Default output directory.
output_frames	Output frames.
recipe_name	Name of the recipe.
version	Recipe version.

Methods Summary

activate_file_logger()	Activate the logging to a file.
deactivate_file_logger()	Deactivate the logging to a file.
dump([include_files, json_col])	Dump recipe results, stats, parameters in a dict.
dump_params([json_col])	Dump non-default parameters to a JSON string.
run(flist, *args[, params])	Run the recipe.

Attributes Documentation

DPR_TYPE = None

Type of data to process (DPR.TYPE). If None, cpl.Recipe.tag is used.

calib_frames

Return the list of calibration frames.

default_params = {}

Default parameters.

exclude_frames = {}

Frames that must be excluded by default.

n_inputs_min = None

Minimum number of input files, as required by the DRS.

output_dir = None

Default output directory.

output_frames = []

Output frames.

recipe_name = None

Name of the recipe.

version = None

Recipe version.

Methods Documentation

activate_file_logger()

Activate the logging to a file.

deactivate_file_logger()

Deactivate the logging to a file.

dump(include_files=False, json_col=False)

Dump recipe results, stats, parameters in a dict.

dump_params(json_col=False)

Dump non-default parameters to a JSON string.

run(flist, *args, params=None, **kwargs)

Run the recipe.

Subclasses must implement BaseRecipe._run to customize this.

Parameters

fliststr, list of str, or dict

List of input raw files. Can be a file, list of files, or a dict with DPR_TYPE as key and list of files as value.

paramsdict

Parameters for the recipe.

*args, **kwargs

Additional arguments are passed to BaseRecipe._run.