Source code for openghg.dataobjects._obsdata

from ._basedata import _BaseData
from openghg.plotting import plot_timeseries as general_plot_timeseries
import plotly.graph_objects as go
from typing import Any, Iterator, Optional

[docs] class ObsData(_BaseData): """This class is used to return observations data. It be created with a preloaded xarray Dataset or with a UUID and version number to retrieve data from Datasource zarr store. """ # Compatability layer for legacy format - mimicking the behaviour of a dictionary # Previous format expected a dictionary containing the site code and data # as key:value pairs. # TODO: May also want to check other expected keys within the legacy # dictionary format and add them below
[docs] def __getitem__(self, key: str) -> Any: """ Returns the data attribute (xarray Dataset) when the site name is specified. Included as a compatability layer for legacy format as a dictionary containing a Dataset for each site code. key (str): Site code """ site = self.metadata["site"].lower() if key.lower() == site: return else: raise KeyError(f"Site '{key}' does not match to expected site '{site}'")
[docs] def __iter__(self) -> Iterator: """ Returns site code as the key for the dictionary as would be expected. """ site = self.metadata["site"] return iter([site])
[docs] def __len__(self) -> int: """ Returns number of key values (fixed at 1 at present) """ # Fixed length as 1 at the moment but may need to update if other key # values are added. return 1
[docs] def __eq__(self, other: object) -> bool: if not isinstance(other, ObsData): return NotImplemented if is None or is None: raise ValueError("Cannot compare data if it is not loaded") return and self.metadata == other.metadata
[docs] def plot_timeseries( self, title: Optional[str] = None, xlabel: Optional[str] = None, ylabel: Optional[str] = None, units: Optional[str] = None, logo: Optional[bool] = True, ) -> go.Figure: """Plot a timeseries""" return general_plot_timeseries( data=self, title=title, xlabel=xlabel, ylabel=ylabel, units=units, logo=logo, )