arctichoke
==========

.. py:module:: arctichoke


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/arctichoke/analysis/index
   /autoapi/arctichoke/arctichoke/index
   /autoapi/arctichoke/dataset/index
   /autoapi/arctichoke/params/index
   /autoapi/arctichoke/path/index
   /autoapi/arctichoke/plot/index
   /autoapi/arctichoke/verify/index


Attributes
----------

.. autoapisummary::

   arctichoke.__version__


Functions
---------

.. autoapisummary::

   arctichoke.get_current_datetime_str


Package Contents
----------------

.. py:data:: __version__

.. py:function:: get_current_datetime_str(str_format: str = '%Y-%m-%dT%H:%M:%SZ')

   Get the current datetime in UTC.

   Format the current datetime into a string based on the given format string.

   :param str_format: The format string by which to format the current datetime.
                      Default is `"%Y-%m-%dT%H:%M:%SZ"`.
   :type str_format: `str`, optional

   :returns: **datetime_str** -- The formatted current datetime as a string.
   :rtype: `str`

   .. rubric:: Examples

   >>> from arctichoke import get_current_datetime_str
   >>> get_current_datetime_str