wrf.g_times.get_times

wrf.g_times.get_times(wrfin, timeidx=0, method='cat', squeeze=True, cache=None, meta=True, _key=None)

Return a sequence of time objects.

This function reads the ‘Times’ variable and creates a sequence of datetime.datetime objects.

Parameters:

• wrfin (netCDF4.Dataset, Nio.NioFile, or an iterable) – WRF-ARW NetCDF data as a netCDF4.Dataset, Nio.NioFile or an iterable sequence of the aforementioned types.
• timeidx (int or wrf.ALL_TIMES) – The desired time index. This value can be a positive integer, negative integer, or wrf.ALL_TIMES (an alias for None) to return all times in the file or sequence.
• method (str, optional) – The aggregation method to use for sequences. Must be either ‘cat’ or ‘join’. ‘cat’ combines the data along the Time dimension. ‘join’ creates a new dimension for the file index. The default is ‘cat’.
• squeeze (bool, optional) – Set to False to prevent dimensions with a size of 1 from being automatically removed from the shape of the output. Default is True.
• cache (dict, optional) – A dictionary of (varname, ndarray) that can be used to supply pre-extracted NetCDF variables to the computational routines. It is primarily used for internal purposes, but can also be used to improve performance by eliminating the need to repeatedly extract the same variables used in multiple diagnostics calculations, particularly when using large sequences of files. Default is None.
• meta (bool, optional) – Set to False to disable metadata.
• _key (int, optional) – A caching key. This is used for internal purposes only. Default is None.

Returns:

A sequence of datetime.datetime objects. If meta is True, the sequence will be of type xarray.DataArray, otherwise the sequence is numpy.ndarray.

Return type:

xarray.DataArray or numpy.ndarray