perun

perun module.

Subpackages

• perun.api
  • perun.api.cli
  • perun.api.decorator
• perun.backend
  • perun.backend.backend
  • perun.backend.nvml
  • perun.backend.powercap_rapl
  • perun.backend.psutil
  • perun.backend.rocmsmi
  • perun.backend.util
• perun.data_model
  • perun.data_model.data
  • perun.data_model.measurement_type
  • perun.data_model.sensor
• perun.io
  • perun.io.bench
  • perun.io.hdf5
  • perun.io.io
  • perun.io.json
  • perun.io.pandas
  • perun.io.pickle
  • perun.io.text_report
  • perun.io.util
• perun.monitoring
  • perun.monitoring.application
  • perun.monitoring.monitor
  • perun.monitoring.subprocess

Submodules

• perun.__main__
• perun.comm
• perun.configuration
• perun.coordination
• perun.core
• perun.logging
• perun.processing
• perun.util

Package Contents

Functions

init_logging(→ logging.Logger)	Initialize logging object.
monitor([region_name])	Decorate function to monitor its energy usage.
register_callback(func)	Register a function to run after perun has finished collection data.
perun([configuration_file])	Decorate function to monitor its energy usage.

Attributes

__version__
config
log

perun.__version__ = '0.7.0'

perun.config: configparser.ConfigParser

perun.init_logging(level: str) → logging.Logger

Initialize logging object.

Parameters

levelstr

Logging level

Returns

Logger

Logger object

perun.log

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

Decorate function to monitor its energy usage.

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

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

Parameters

funcCallable[[DataNode], None]

Function to be called.

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

Decorate function to monitor its energy usage.