perun

perun module.

Submodules

• perun.api
• perun.backend
• perun.comm
• perun.configuration
• perun.coordination
• perun.core
• perun.data_model
• perun.io
• perun.logging
• perun.monitoring
• perun.processing
• perun.util

Functions

monitor(→ Callable)	Decorate function to monitor its energy usage.
perun(→ Callable)	Decorate function to monitor its energy usage.
register_callback(→ None)	Register a function to run after perun has finished collection data.

Package Contents

perun.monitor(region_name: str | None = None) → Callable

Decorate function to monitor its energy usage.

perun.perun(configuration_file: str = './.perun.ini', **conf_kwargs: Any) → Callable

Decorate function to monitor its energy usage.

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

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

Parameters:

func (Callable[[DataNode], None]) – Function to be called.