🍾 Xarray is now 10 years old! 🎉

xarray.core.accessor_dt.DatetimeAccessor

xarray.core.accessor_dt.DatetimeAccessor#

class xarray.core.accessor_dt.DatetimeAccessor(obj)[source]#

Access datetime fields for DataArrays with datetime-like dtypes.

Fields can be accessed through the .dt attribute for applicable DataArrays.

Examples

>>> dates = pd.date_range(start="2000/01/01", freq="D", periods=10)
>>> ts = xr.DataArray(dates, dims=("time"))
>>> ts
<xarray.DataArray (time: 10)> Size: 80B
array(['2000-01-01T00:00:00.000000000', '2000-01-02T00:00:00.000000000',
       '2000-01-03T00:00:00.000000000', '2000-01-04T00:00:00.000000000',
       '2000-01-05T00:00:00.000000000', '2000-01-06T00:00:00.000000000',
       '2000-01-07T00:00:00.000000000', '2000-01-08T00:00:00.000000000',
       '2000-01-09T00:00:00.000000000', '2000-01-10T00:00:00.000000000'],
      dtype='datetime64[ns]')
Coordinates:
  * time     (time) datetime64[ns] 80B 2000-01-01 2000-01-02 ... 2000-01-10
>>> ts.dt  
<xarray.core.accessor_dt.DatetimeAccessor object at 0x...>
>>> ts.dt.dayofyear
<xarray.DataArray 'dayofyear' (time: 10)> Size: 80B
array([ 1,  2,  3,  4,  5,  6,  7,  8,  9, 10])
Coordinates:
  * time     (time) datetime64[ns] 80B 2000-01-01 2000-01-02 ... 2000-01-10
>>> ts.dt.quarter
<xarray.DataArray 'quarter' (time: 10)> Size: 80B
array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1])
Coordinates:
  * time     (time) datetime64[ns] 80B 2000-01-01 2000-01-02 ... 2000-01-10
__init__(obj)[source]#

Methods

__init__(obj)

ceil(freq)

Round timestamps upward to specified frequency resolution.

floor(freq)

Round timestamps downward to specified frequency resolution.

isocalendar()

Dataset containing ISO year, week number, and weekday.

round(freq)

Round timestamps to specified frequency resolution.

strftime(date_format)

Return an array of formatted strings specified by date_format, which supports the same string format as the python standard library.

Attributes

calendar

The name of the calendar of the dates.

date

Date corresponding to datetimes

day

The days of the datetime

dayofweek

The day of the week with Monday=0, Sunday=6

dayofyear

The ordinal day of the year

days_in_month

The number of days in the month

daysinmonth

The number of days in the month

hour

The hours of the datetime

is_leap_year

Indicate if the date belongs to a leap year

is_month_end

Indicate whether the date is the last day of the month

is_month_start

Indicate whether the date is the first day of the month

is_quarter_end

Indicate whether the date is the last day of a quarter

is_quarter_start

Indicate whether the date is the first day of a quarter

is_year_end

Indicate whether the date is the last day of the year

is_year_start

Indicate whether the date is the first day of a year

microsecond

The microseconds of the datetime

minute

The minutes of the datetime

month

The month as January=1, December=12

nanosecond

The nanoseconds of the datetime

quarter

The quarter of the date

season

Season of the year

second

The seconds of the datetime

time

Timestamps corresponding to datetimes

week

The week ordinal of the year

weekday

The day of the week with Monday=0, Sunday=6

weekofyear

The week ordinal of the year

year

The year of the datetime