From d59dcdbf40a10ad462e8009715db787724122f0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20S=C3=A1nchez-Gallego?= Date: Wed, 7 Aug 2024 06:17:38 +0000 Subject: [PATCH] Add log routes for exposures --- src/lvmapi/app.py | 2 + src/lvmapi/routers/__init__.py | 9 +++ src/lvmapi/routers/log.py | 75 ++++++++++++++++++ src/lvmapi/tasks.py | 11 +++ src/lvmapi/tools/log.py | 137 +++++++++++++++++++++++++++++++++ 5 files changed, 234 insertions(+) create mode 100644 src/lvmapi/routers/log.py create mode 100644 src/lvmapi/tools/log.py diff --git a/src/lvmapi/app.py b/src/lvmapi/app.py index f5d7795..4afee7d 100644 --- a/src/lvmapi/app.py +++ b/src/lvmapi/app.py @@ -19,6 +19,7 @@ enclosure, ephemeris, kubernetes, + log, macros, overwatcher, slack, @@ -45,6 +46,7 @@ app.include_router(tasks.router) app.include_router(kubernetes.router) app.include_router(actors.router) +app.include_router(log.router) # Lifecycle events for the broker. diff --git a/src/lvmapi/routers/__init__.py b/src/lvmapi/routers/__init__.py index e69de29..32d3502 100644 --- a/src/lvmapi/routers/__init__.py +++ b/src/lvmapi/routers/__init__.py @@ -0,0 +1,9 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @Author: José Sánchez-Gallego (gallegoj@uw.edu) +# @Date: 2024-08-06 +# @Filename: __init__.py +# @License: BSD 3-clause (http://www.opensource.org/licenses/BSD-3-Clause) + +from __future__ import annotations diff --git a/src/lvmapi/routers/log.py b/src/lvmapi/routers/log.py new file mode 100644 index 0000000..28732ff --- /dev/null +++ b/src/lvmapi/routers/log.py @@ -0,0 +1,75 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @Author: José Sánchez-Gallego (gallegoj@uw.edu) +# @Date: 2024-08-06 +# @Filename: log.py +# @License: BSD 3-clause (http://www.opensource.org/licenses/BSD-3-Clause) + +from __future__ import annotations + +import asyncio + +from fastapi import APIRouter, Path, Query + +from lvmapi.tasks import get_exposure_data_task +from lvmapi.tools.log import get_exposure_data, get_exposures, get_mjds + + +router = APIRouter(prefix="/log", tags=["log"]) + + +@router.get("/") +async def get_log(): + """Not implemented.""" + + return {} + + +@router.get("/mjds") +async def get_mjds_route(): + """Returns a list of MJDs with spectrograph data (or at least a folder).""" + + mjds = await asyncio.get_event_loop().run_in_executor(None, get_mjds) + return mjds + + +@router.get( + "/exposures/{mjd}", + description="Returns a list of exposures for an MJD.", +) +async def get_exposures_route( + mjd: int = Path( + title="The SJD (Sloan-flavoured MJD) for which to list exposures.", + ), +): + """Returns a list of exposures for an MJD.""" + + executor = asyncio.get_event_loop().run_in_executor + exposures = await executor(None, get_exposures, mjd) + + return list(map(str, exposures)) + + +@router.get( + "/exposures/data/{mjd}", + description="Returns data from exposures for an MJD.", +) +async def get_exposure_data_route( + mjd: int = Path( + title="The SJD (Sloan-flavoured MJD) for which to list exposures.", + ), + as_task: bool = Query( + False, + description="Whether to schedule this as a task.", + ), +): + """Returns a log of exposures for an MJD..""" + + if as_task is False: + executor = asyncio.get_event_loop().run_in_executor + exposure_data = await executor(None, get_exposure_data, mjd) + return exposure_data + + task = await get_exposure_data_task.kiq(mjd) + return task.task_id diff --git a/src/lvmapi/tasks.py b/src/lvmapi/tasks.py index c9ee4b4..623fe08 100644 --- a/src/lvmapi/tasks.py +++ b/src/lvmapi/tasks.py @@ -65,3 +65,14 @@ async def restart_kubernetes_deployment_task(deployment: str, confirm: bool = Tr return True raise TimeoutError(f"Timed out waiting for {deployment} to start.") + + +@broker.task() +async def get_exposure_data_task(mjd: int): + """Returns the list of exposures for a given MJD.""" + + from lvmapi.tools.log import get_exposure_data + + exposure_data = get_exposure_data(mjd) + + return exposure_data diff --git a/src/lvmapi/tools/log.py b/src/lvmapi/tools/log.py new file mode 100644 index 0000000..707a4c7 --- /dev/null +++ b/src/lvmapi/tools/log.py @@ -0,0 +1,137 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @Author: José Sánchez-Gallego (gallegoj@uw.edu) +# @Date: 2024-08-06 +# @Filename: log.py +# @License: BSD 3-clause (http://www.opensource.org/licenses/BSD-3-Clause) + +from __future__ import annotations + +import pathlib +import re + +from astropy.io import fits +from pydantic import BaseModel + + +class ExposureDataDict(BaseModel): + """A dictionary of exposure data.""" + + exposure_no: int + mjd: int + obstime: str = "" + image_type: str = "" + exposure_time: float | None = None + ra: float | None = None + dec: float | None = None + airmass: float | None = None + lamps: dict[str, bool] = {} + n_standards: int = 0 + n_cameras: int = 0 + object: str = "" + + +def get_mjds(): + """Returns a list of MJDs with spectrograph data (or at least a folder).""" + + paths = list(pathlib.Path("/data/spectro/").glob("*")) + mjds: list[int] = [] + for path in paths: + try: + mjd = int(path.parts[-1]) + mjds.append(mjd) + except ValueError: + continue + + return sorted(mjds) + + +def get_exposures(mjd: int): + """Returns a list of spectrograph exposures for an MJD.""" + + files = pathlib.Path(f"/data/spectro/{mjd}/").glob("*.fits.gz") + + return files + + +def get_exposure_no(file_: pathlib.Path | str): + """Returns the exposure number from a file path.""" + + file_ = pathlib.Path(file_) + name = file_.name + + match = re.match(r"sdR-s-[brz][1-3]-(\d+).fits.gz", name) + if not match: + return None + + return int(match.group(1)) + + +def get_exposure_paths(mjd: int, exposure_no: int): + """Returns the path to the exposure file.""" + + return pathlib.Path(f"/data/spectro/{mjd}/").glob(f"*{exposure_no}.fits.gz") + + +def get_exposure_data(mjd: int): + """Returns the data for the exposures from a given MJD.""" + + data: dict[int, ExposureDataDict] = {} + files = list(get_exposures(mjd)) + + exposure_nos = [get_exposure_no(file_) for file_ in files] + exposure_nos_set = set([e_no for e_no in exposure_nos if e_no is not None]) + + for exposure_no in sorted(exposure_nos_set): + exposure_paths = list(get_exposure_paths(mjd, exposure_no)) + + if len(exposure_paths) == 0: + data[exposure_no] = ExposureDataDict( + exposure_no=exposure_no, + mjd=mjd, + n_cameras=0, + ) + continue + + with fits.open(exposure_paths[0]) as hdul: + header = hdul[0].header + + obstime = header.get("OBSTIME", "") + image_type = header.get("IMAGETYP", "") + exposure_time = header.get("EXPTIME", None) + ra = header.get("TESCIRA", None) + dec = header.get("TESCIDE", None) + airmass = header.get("TESCIAM", None) + n_standards = sum([header[f"STD{nn}ACQ"] for nn in range(1, 13)]) + n_cameras = len(exposure_paths) + object = header.get("OBJECT", "") + + lamps = { + lamp_name: header[lamp_header] == "ON" + for lamp_header, lamp_name in [ + ("ARGON", "Argon"), + ("NEON", "Neon"), + ("LDLS", "LDLS"), + ("QUARTZ", "Quartz"), + ("HGNE", "HgNe"), + ("XENON", "Xenon"), + ] + } + + data[exposure_no] = ExposureDataDict( + exposure_no=exposure_no, + mjd=mjd, + obstime=obstime, + image_type=image_type, + exposure_time=exposure_time, + ra=ra, + dec=dec, + airmass=airmass, + lamps=lamps, + n_standards=n_standards, + n_cameras=n_cameras, + object=object, + ) + + return data