AbstractDataModel

class stpipe.datamodel.AbstractDataModel

Bases: ABC

This Abstract Base Class is intended to cover multiple implementations of data models so that each will be considered an appropriate subclass of this class without requiring that they inherit this class.

Any datamodel class instance that desires to be considered an instance of AbstractDataModel must implement the following methods.

In addition, although it isn’t yet checked (the best approach for supporting this is still being considered), such instances must have a meta.filename attribute.

Attributes Summary

crds_observatory

This should return a string identifying the observatory as CRDS expects it

Methods Summary

get_crds_parameters()	This should return a dictionary of key/value pairs corresponding to the parkey values CRDS is using to match reference files.
save(path[, dir_path])	Save to a file.

Attributes Documentation

crds_observatory

This should return a string identifying the observatory as CRDS expects it

Methods Documentation

abstractmethod get_crds_parameters()

This should return a dictionary of key/value pairs corresponding to the parkey values CRDS is using to match reference files. Typically it returns all metadata simple values.

abstractmethod save(path, dir_path=None, *args, **kwargs)

Save to a file.

Parameters:

pathstring or callable

File path to save to. If function, it takes one argument that is model.meta.filename and returns the full path string.

dir_pathstr

Directory to save to. If not None, this will override any directory information in the path

Returns:

output_path: str

The file path the model was saved in.