perun.core

Core perun functionality.

Attributes

log

Classes

Perun

Perun object.

Module Contents

perun.core.log

class perun.core.Perun(config: configparser.ConfigParser)

Perun object.

config

_comm: perun.comm.Comm | None = None

_backends: Dict[str, perun.backend.backend.Backend] | None = None

_g_available_sensors: List[Dict[str, Tuple]] = []

_l_available_sensors: Dict[str, Tuple]

_g_assigned_sensors: List[Dict[str, Tuple]] = []

_l_assigned_sensors: Dict[str, Tuple]

_host_rank: Dict[str, List[int]] | None = None

_hostname: str | None = None

_l_host_metadata: Dict[str, Any] | None = None

_l_backend_metadata: Dict[str, Any] | None = None

_monitor: perun.monitoring.monitor.PerunMonitor | None = None

postprocess_callbacks: Dict[str, Callable[[perun.data_model.data.DataNode], None]]

warmup_round: bool = False

__del__(): Perun object destructor.

property comm: perun.comm.Comm: Lazy initialization of mpi communication object.

property hostname: str

Lazy initialization of hostname.

Returns

str: Local rank hostname.

property backends: Dict[str, perun.backend.backend.Backend]

Lazy initialization of backends dictionary.

Returns

Dict[str, Backend]: Dictionary of available backends.

_close_backends(): Close available backends.

property host_rank: Dict[str, List[int]]

Lazy initialization of host_rank dictionary.

Returns

Dict[str, List[int]]: Dictionary with key (hostname) and values (list of ranks in host)

property l_available_sensors: Dict[str, Tuple]

Lazy initialization of local available sensors.

Returns

Dict[str, Tuple[str]]: Local available sensor.

property g_available_sensors: List[Dict[str, Tuple]]

Lazy initialization of global available sensors.

Returns

List[Dict[str, Tuple[str]]]: Global available sensor.

property g_assigned_sensors: List[Dict[str, Tuple]]

Lazy initialization of global sensors assignment.

Returns

List[Dict[str, Tuple[str]]]: Local assigned sensors.

property l_assigned_sensors: Dict[str, Tuple]

Lazy initialization of local assigned sensors.

Returns

Dict[str, Tuple[str]]: Local assigned sensors.

property l_host_metadata: Dict[str, Any]

Lazy initialization of local metadata dictionary.

Returns

Dict[str, Any]: Metadata dictionary

property l_backend_metadata: Dict[str, Any]

Lazy initialization of local metadata dictionary.

Returns

Dict[str, Any]: Metadata dictionary

mark_event(region_id: str)

Mark an event for a specific region.

Parameters

region_idstr: The ID of the region to mark the event for.

Returns

None

monitor_application(app: perun.monitoring.application.Application) → Any

Execute coordination, monitoring, post-processing, and reporting steps, in that order.

Parameters

appPath: App script file path

Returns

Any: Last result of the application execution, only when the perun decorator is used.

_export_multirun(multirun_node: perun.data_model.data.DataNode)

_process_multirun(multirun_nodes: Dict[str, perun.data_model.data.DataNode]) → perun.data_model.data.DataNode

import_from(filePath: pathlib.Path, format: perun.io.io.IOFormat) → perun.data_model.data.DataNode

Import data node from given filepath.

Parameters

filePathPath: Perun data node file path.
formatIOFormat: File format.

Returns

DataNode: Imported DataNode.

export_to(dataOut: pathlib.Path, dataNode: perun.data_model.data.DataNode, format: perun.io.io.IOFormat, mr_id: str | None = None)

Export data to selected format.

Parameters

dataOutPath: Directory where data will be saved.
dataNodeDataNode: Data node to export.
formatIOFormat: Format to export data.

_run_postprocess_callbacks(dataNode: perun.data_model.data.DataNode)