perun
=====

.. py:module:: perun

.. autoapi-nested-parse::

   perun module.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/perun/__main__/index
   /autoapi/perun/api/index
   /autoapi/perun/backend/index
   /autoapi/perun/comm/index
   /autoapi/perun/configuration/index
   /autoapi/perun/coordination/index
   /autoapi/perun/core/index
   /autoapi/perun/data_model/index
   /autoapi/perun/io/index
   /autoapi/perun/logging/index
   /autoapi/perun/monitoring/index
   /autoapi/perun/processing/index
   /autoapi/perun/util/index


Attributes
----------

.. autoapisummary::

   perun.__version__
   perun.config
   perun.log


Functions
---------

.. autoapisummary::

   perun.init_logging
   perun.monitor
   perun.register_callback
   perun.perun


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

.. py:data:: __version__
   :value: '0.8.9'


.. py:data:: config
   :type:  configparser.ConfigParser

.. py:function:: init_logging(level: str) -> logging.Logger

   Initialize logging object.

   Parameters
   ----------
   level : str
       Logging level

   Returns
   -------
   Logger
       Logger object


.. py:data:: log

.. py:function:: monitor(region_name: Optional[str] = None)

   Decorate function to monitor its energy usage.


.. py:function:: register_callback(func: Callable[[perun.data_model.data.DataNode], None])

   Register a function to run after perun has finished collection data.

   Parameters
   ----------
   func : Callable[[DataNode], None]
       Function to be called.


.. py:function:: perun(configuration_file: str = './.perun.ini', **conf_kwargs)

   Decorate function to monitor its energy usage.