astromodule.utils.iauname_path

iauname_path(iaunames: str | Sequence[str] = None, ra: float | Sequence[float] = None, dec: float | Sequence[float] = None, prefix: str | Path = '', suffix: str = '', flat: bool = False, return_str: bool = False) → Path | Sequence[Path]

Calculate the nested path for a given iauname

Parameters:

iaunames: str, List[str], optional

Object iauname. The iauname or RA and DEC must be passed, if iaunames is None, this function computes the iauname using the ra and dec parameters

ra: float, List[float], optional

Object RA, used only if iaunames is None

dec: float, List[float], optional

Object DEC, used only if iaunames is None

prefix: str, Path, optional

Path that will be prepended at the begin of all paths

suffix: str, optional

Suffix that will be appended at the end of all paths

flat: bool, optional

Create the flat path with all files inside a same parent folder. This is not recomended for big datasets

return_str: bool, optional

Cast all paths to string before returning

Returns:

Path, List[Path]

The iauname path