Source code for ATK.Tools.read

from pathlib import Path

from ..io.files.read import read_local
from ..structures.DataSet import DataSet




def read(path: str | Path) -> DataSet:
    """
    Reads a local ATK FITS file to recreate the original :class:`~ATK.Models.DataSet`.

    Parameters
    ----------
    path : str or :class:`~pathlib.Path`
        Path to file.

    See Also
    --------
    :class:`~ATK.Models.DataSet` : Data structure from which a local ATK FITS file can be generated.
    :meth:`~ATK.Models.DataSet.store` : :class:`~ATK.Models.DataSet` method from which an ATK FITS file can be generated.
    """

    return read_local(path)