perun.api.decorator
===================

.. py:module:: perun.api.decorator

.. autoapi-nested-parse::

   Decorator module.



Attributes
----------

.. autoapisummary::

   perun.api.decorator.log


Functions
---------

.. autoapisummary::

   perun.api.decorator.monitor
   perun.api.decorator.perun
   perun.api.decorator.register_callback


Module Contents
---------------

.. py:data:: log

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

   Decorate function to monitor its energy usage.


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

   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.