perun.core
==========

.. py:module:: perun.core

.. autoapi-nested-parse::

   Core perun functionality.



Attributes
----------

.. autoapisummary::

   perun.core.log


Classes
-------

.. autoapisummary::

   perun.core.Perun


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

.. py:data:: log

.. py:class:: Perun(config: configparser.ConfigParser)

   Perun object.


   .. py:attribute:: config


   .. py:attribute:: warmup_round
      :type:  bool
      :value: False



   .. py:property:: comm
      :type: perun.comm.Comm


      Lazy initialization of mpi communication object.


   .. py:property:: hostname
      :type: str


      Lazy initialization of hostname.

      :returns: Local rank hostname.
      :rtype: str


   .. py:property:: backends
      :type: dict[str, perun.backend.Backend]


      Lazy initialization of backends dictionary.

      :returns: Dictionary of available backends.
      :rtype: dict[str, Backend]


   .. py:property:: host_rank
      :type: dict[str, list[int]]


      Lazy initialization of host_rank dictionary.

      :returns: Dictionary with key (hostname) and values (list of ranks in host)
      :rtype: dict[str, list[int]]


   .. py:property:: l_available_sensors
      :type: dict[str, tuple]


      Lazy initialization of local available sensors.

      :returns: Local available sensor.
      :rtype: dict[str, tuple[str]]


   .. py:property:: g_available_sensors
      :type: list[dict[str, tuple]]


      Lazy initialization of global available sensors.

      :returns: Global available sensor.
      :rtype: list[dict[str, tuple[str]]]


   .. py:property:: g_assigned_sensors
      :type: list[dict[str, tuple]]


      Lazy initialization of global sensors assignment.

      :returns: Local assigned sensors.
      :rtype: list[dict[str, tuple[str]]]


   .. py:property:: l_assigned_sensors
      :type: dict[str, tuple]


      Lazy initialization of local assigned sensors.

      :returns: Local assigned sensors.
      :rtype: dict[str, tuple[str]]


   .. py:property:: l_host_metadata
      :type: dict[str, Any]


      Lazy initialization of local metadata dictionary.

      :returns: Metadata dictionary
      :rtype: dict[str, Any]


   .. py:property:: l_backend_metadata
      :type: dict[str, Any]


      Lazy initialization of local metadata dictionary.

      :returns: Metadata dictionary
      :rtype: dict[str, Any]


   .. py:method:: mark_event(region_id: str) -> None

      Mark an event for a specific region.

      :param region_id: The ID of the region to mark the event for.
      :type region_id: str



   .. py:method:: monitor_application(app: perun.monitoring.application.Application) -> tuple[perun.monitoring.monitor.MonitorStatus, Any]

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

      :param app: App script file path
      :type app: Path

      :returns: Return the output status from the monitoring process, and the last result of the application execution (if any).
      :rtype: tuple[MonitorStatus, Any]



   .. py:method:: import_from(filePath: pathlib.Path, format: perun.io.io.IOFormat) -> perun.data_model.data.DataNode

      Import data node from given filepath.

      :param filePath: Perun data node file path.
      :type filePath: Path
      :param format: File format.
      :type format: IOFormat

      :returns: Imported DataNode.
      :rtype: DataNode



   .. py:method:: export_to(dataOut: pathlib.Path, dataNode: perun.data_model.data.DataNode, format: perun.io.io.IOFormat, mr_id: str = '') -> None

      Export data to selected format.

      :param dataOut: Directory where data will be saved.
      :type dataOut: Path
      :param dataNode: Data node to export.
      :type dataNode: DataNode
      :param format: Format to export data.
      :type format: IOFormat
      :param mr_id: The id of the multi_run to be exported, the last one if left empty.
      :type mr_id: str, optional