.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/ex_dateutils.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_ex_dateutils.py>`
        to download the full example code. or to run this example in your browser via Binder

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_ex_dateutils.py:


********************
Numpy date utilities
********************

This library provides utility functions to perform conversions and get
information about numpy dates quickly.

.. GENERATED FROM PYTHON SOURCE LINES 10-29

.. code-block:: Python

    import datetime
    import random

    import numpy

    import pyinterp


    def make_date(samples=10000):
        """Generates random dates."""
        epoch = datetime.datetime(1970, 1, 1)
        delta = datetime.datetime.now() - datetime.datetime(1970, 1, 1)

        pydates = [epoch + random.random() * delta for _ in range(samples)]
        npdates = numpy.array(pydates).astype('datetime64[ns]')

        return npdates









.. GENERATED FROM PYTHON SOURCE LINES 30-33

.. code-block:: Python

    dates = make_date()
    print(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    ['2021-07-08T23:27:01.728351000' '1986-01-06T22:19:53.876026000'
     '2014-08-22T03:48:47.576783000' ... '1972-07-08T02:22:03.425555000'
     '2024-06-20T17:24:15.309957000' '2002-04-21T19:33:09.506837000']




.. GENERATED FROM PYTHON SOURCE LINES 34-36

Get the date part as a structured numpy array of three fields: ``year``,
``month`` and ``day``:

.. GENERATED FROM PYTHON SOURCE LINES 36-38

.. code-block:: Python

    pyinterp.dateutils.date(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([(2021, 7,  8), (1986, 1,  6), (2014, 8, 22), ..., (1972, 7,  8),
           (2024, 6, 20), (2002, 4, 21)],
          shape=(10000,), dtype=[('year', '<i4'), ('month', '<u4'), ('day', '<u4')])



.. GENERATED FROM PYTHON SOURCE LINES 39-41

Get the time part as a structured numpy array of three fields: ``hour``,
``minute`` and ``second``:

.. GENERATED FROM PYTHON SOURCE LINES 41-43

.. code-block:: Python

    pyinterp.dateutils.time(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([(23, 27,  1), (22, 19, 53), ( 3, 48, 47), ..., ( 2, 22,  3),
           (17, 24, 15), (19, 33,  9)],
          shape=(10000,), dtype=[('hour', '<u4'), ('minute', '<u4'), ('second', '<u4')])



.. GENERATED FROM PYTHON SOURCE LINES 44-46

Get the ISO calendar of the date as a structured numpy array of three fields:
``year``, ``weekday`` and ``week``:

.. GENERATED FROM PYTHON SOURCE LINES 46-48

.. code-block:: Python

    pyinterp.dateutils.isocalendar(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([(2021, 27, 4), (1986,  2, 1), (2014, 34, 5), ..., (1972, 27, 6),
           (2024, 25, 4), (2002, 16, 7)],
          shape=(10000,), dtype=[('year', '<i4'), ('week', '<u4'), ('weekday', '<u4')])



.. GENERATED FROM PYTHON SOURCE LINES 49-50

Get the week day of the dates (Sunday is 0 ... Saturday is 6):

.. GENERATED FROM PYTHON SOURCE LINES 50-52

.. code-block:: Python

    pyinterp.dateutils.weekday(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([4, 1, 5, ..., 6, 4, 0], shape=(10000,), dtype=uint32)



.. GENERATED FROM PYTHON SOURCE LINES 53-54

Get the timedelta from since January

.. GENERATED FROM PYTHON SOURCE LINES 54-56

.. code-block:: Python

    pyinterp.dateutils.timedelta_since_january(dates)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([16327621728351000,   512393876026000, 20144927576783000, ...,
           16338123425555000, 14837055309957000,  9574389506837000],
          shape=(10000,), dtype='timedelta64[ns]')



.. GENERATED FROM PYTHON SOURCE LINES 57-58

Get the dates as datetime.datetime array

.. GENERATED FROM PYTHON SOURCE LINES 58-59

.. code-block:: Python

    pyinterp.dateutils.datetime(dates)




.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    array([datetime.datetime(2021, 7, 8, 23, 27, 1, 728351),
           datetime.datetime(1986, 1, 6, 22, 19, 53, 876026),
           datetime.datetime(2014, 8, 22, 3, 48, 47, 576783), ...,
           datetime.datetime(1972, 7, 8, 2, 22, 3, 425555),
           datetime.datetime(2024, 6, 20, 17, 24, 15, 309957),
           datetime.datetime(2002, 4, 21, 19, 33, 9, 506837)],
          shape=(10000,), dtype=object)




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.022 seconds)


.. _sphx_glr_download_auto_examples_ex_dateutils.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: binder-badge

      .. image:: images/binder_badge_logo.svg
        :target: https://mybinder.org/v2/gh/CNES/pangeo-pyinterp/master?urlpath=lab/tree/notebooks/auto_examples/ex_dateutils.ipynb
        :alt: Launch binder
        :width: 150 px

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: ex_dateutils.ipynb <ex_dateutils.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: ex_dateutils.py <ex_dateutils.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: ex_dateutils.zip <ex_dateutils.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_