Stack API for locating/reading files contained in an EUPS package?

jsick · June 24, 2016, 5:52pm

Newbie question here: what’s the appropriate API for locating or even opening a file that’s included inside an EUPS package. Say I want to include a YAML file with KPM definitions from LPM-17 in the validate_drp package. What API do I use to build an absolute path to that file in the installed validate_drp, or even read a file object? I’m looking for the EUPS equivalent of setuptools’ pkg_resources.

ktl · June 24, 2016, 5:53pm

github.com

lsst/utils/blob/master/include/lsst/utils/Utils.h#L40-L47


/*!
* \brief return the root directory of a setup package
*
* \param[in] packageName  name of package (e.g. "utils")
*
* \throw lsst::pex::exceptions::NotFoundError if desired version can't be found
*/
std::string getPackageDir(std::string const& packageName);

Also available in Python via SWIG.

price · June 24, 2016, 6:05pm

In python:

import os
from lsst.utils import getPackageDir
filename = os.path.join(getPackageDir("validate_drp"), "examples", "Decam.yaml")