Source code for swvo.io.kp.omni

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

"""
Module holding the reader for reading Kp data from OMNI files.
"""

from __future__ import annotations

from datetime import datetime, timedelta

import pandas as pd

from swvo.io.omni import OMNILowRes




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

    _READ_TIME_PADDING = timedelta(hours=2.9999)



    def read(  # ty: ignore[invalid-method-override]
        self, start_time: datetime, end_time: datetime, download: bool = False
    ) -> pd.DataFrame:
        """
        Extract Kp data from OMNI Low Resolution files.

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

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

        data_out = super().read(start_time, end_time, download=download, variables="kp")
        kp_df = pd.DataFrame(index=data_out.index)

        kp_df["kp"] = data_out["kp"]
        kp_df["file_name"] = data_out["file_name"]
        # we return it just every 3 hours
        kp_df = kp_df.drop(kp_df[data_out.index.hour % 3 != 0].index, axis=0)  # ty: ignore[unresolved-attribute]
        return kp_df  # noqa: RET504