Skip to content

get_start_time

Functions:

Name Description
get_start_time

Functions#

get_start_time #

get_start_time(dataset: xr.Dataset) -> pd.Timestamp

Gets the earliest 'time' value and returns it as a pandas Timestamp.

Parameters:

Name Type Description Default
dataset Dataset

The dataset whose start time should be retrieved.

 required

Returns:

Type Description
Timestamp

pd.Timestamp: The timestamp of the earliest time value in the dataset.
Source code in tsdat/utils/get_start_time.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
def get_start_time(dataset: xr.Dataset) -> pd.Timestamp:
    """---------------------------------------------------------------------------------
    Gets the earliest 'time' value and returns it as a pandas Timestamp.

    Args:
        dataset (xr.Dataset): The dataset whose start time should be retrieved.

    Returns:
        pd.Timestamp: The timestamp of the earliest time value in the dataset.

    ---------------------------------------------------------------------------------"""
    time64: np.datetime64 = np.min(dataset["time"].data)  # type: ignore
    datetime: pd.Timestamp = pd.to_datetime(time64)  # type: ignore
    return datetime