get_pypeit_data_path

specreduce.calibration_data.get_pypeit_data_path(path=None, cache=True, show_progress=False)

Convenience utility to facilitate access to pypeit reference data. The data is accessed directly from the release branch on GitHub and downloaded/cached using download_file.

Parameters:

pathstr or None (default: None)

Filename of reference file relative to the reference_data directory within specreduce_data package.

cachebool (default: False)

Set whether file is cached if file is downloaded.

show_progressbool (default: False)

Set whether download progress bar is shown if file is downloaded.

Returns:

file_pathstr or None

Path to reference data file or None if the path cannot be constructed or if the file itself is not valid.

Examples

>>> from specreduce.calibration_data import get_pypeit_data_path
>>> pypeit_he_linelist = get_pypeit_data_path("arc_lines/lists/HeI_lines.dat")