Source code for swvo.io.f10_7.omni

# SPDX-FileCopyrightText: 2025 GFZ Helmholtz Centre for Geosciences
#
# SPDX-License-Identifier: Apache-2.0

"""
Module for handling F10.7 data from OMNI low resolution files.
"""

from __future__ import annotations

import logging
from datetime import datetime, timedelta

import numpy as np
import pandas as pd

from swvo.io.omni import OMNILowRes
from swvo.io.utils import enforce_utc_timezone

logger = logging.getLogger(__name__)


logging.captureWarnings(True)




class F107OMNI(OMNILowRes):
    """
    Class for reading F10.7 data from OMNI low resolution files.
    Inherits the :func:`download_and_process`, other private methods and attributes from :class:`OMNILowRes`.
    """

    # data is downloaded along with OMNI data, check file name in parent class


    def read(self, start_time: datetime, end_time: datetime, download: bool = False) -> pd.DataFrame:
        """
        Extract F10.7 data from OMNI Low Resolution files.

        Parameters
        ----------
        start_time : datetime
            Start time of the data to read. Must be timezone-aware.
        end_time : datetime
            End time of the data to read. Must be timezone-aware.
        download : bool, optional
            Download data on the go, defaults to False.

        Returns
        -------
        :class:`pandas.DataFrame`
            F10.7 from OMNI Low Resolution data.
        """

        if start_time > end_time:
            msg = "start_time must be before end_time"
            logger.error(msg)
            raise ValueError(msg)

        start_time = enforce_utc_timezone(start_time)
        end_time = enforce_utc_timezone(end_time)

        data_out = super().read(start_time, end_time, download=download)

        f107_df = pd.DataFrame(index=data_out.index)

        f107_df["f107"] = data_out["f107"]
        f107_df["file_name"] = data_out["file_name"]

        # we return it just every 24 hours
        f107_df = f107_df.drop(f107_df[data_out.index.hour % 24 != 0].index, axis=0)  # ty: ignore[unresolved-attribute]
        f107_df = f107_df.replace(999.9, np.nan)
        f107_df = f107_df.truncate(
            before=start_time - timedelta(hours=23.9999),
            after=end_time + timedelta(hours=23.9999),
        )

        return f107_df  # noqa: RET504