perun
=====

.. py:module:: perun

.. autoapi-nested-parse::

   perun module.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /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


Functions
---------

.. autoapisummary::

   perun.monitor
   perun.perun
   perun.register_callback


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

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

   Decorate function to monitor its energy usage.


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

   Decorate function to monitor its energy usage.


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

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

   :param func: Function to be called.
   :type func: Callable[[DataNode], None]