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:: _comm
      :type:  Optional[perun.comm.Comm]
      :value: None



   .. py:attribute:: _backends
      :type:  Optional[Dict[str, perun.backend.backend.Backend]]
      :value: None



   .. py:attribute:: _g_available_sensors
      :type:  List[Dict[str, Tuple]]
      :value: []



   .. py:attribute:: _l_available_sensors
      :type:  Dict[str, Tuple]


   .. py:attribute:: _g_assigned_sensors
      :type:  List[Dict[str, Tuple]]
      :value: []



   .. py:attribute:: _l_assigned_sensors
      :type:  Dict[str, Tuple]


   .. py:attribute:: _host_rank
      :type:  Optional[Dict[str, List[int]]]
      :value: None



   .. py:attribute:: _hostname
      :type:  Optional[str]
      :value: None



   .. py:attribute:: _l_host_metadata
      :type:  Optional[Dict[str, Any]]
      :value: None



   .. py:attribute:: _l_backend_metadata
      :type:  Optional[Dict[str, Any]]
      :value: None



   .. py:attribute:: _monitor
      :type:  Optional[perun.monitoring.monitor.PerunMonitor]
      :value: None



   .. py:attribute:: postprocess_callbacks
      :type:  Dict[str, Callable[[perun.data_model.data.DataNode], None]]


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



   .. py:method:: __del__()

      Perun object destructor.



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

      Lazy initialization of mpi communication object.



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

      Lazy initialization of hostname.

      Returns
      -------
      str
          Local rank hostname.



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

      Lazy initialization of backends dictionary.

      Returns
      -------
      Dict[str, Backend]
          Dictionary of available backends.



   .. py:method:: _close_backends()

      Close available backends.



   .. py:property:: host_rank
      :type: 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)



   .. py:property:: l_available_sensors
      :type: Dict[str, Tuple]

      Lazy initialization of local available sensors.

      Returns
      -------
      Dict[str, Tuple[str]]
          Local available sensor.



   .. py:property:: g_available_sensors
      :type: List[Dict[str, Tuple]]

      Lazy initialization of global available sensors.

      Returns
      -------
      List[Dict[str, Tuple[str]]]
          Global available sensor.



   .. py:property:: g_assigned_sensors
      :type: List[Dict[str, Tuple]]

      Lazy initialization of global sensors assignment.

      Returns
      -------
      List[Dict[str, Tuple[str]]]
          Local assigned sensors.



   .. py:property:: l_assigned_sensors
      :type: Dict[str, Tuple]

      Lazy initialization of local assigned sensors.

      Returns
      -------
      Dict[str, Tuple[str]]
          Local assigned sensors.



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

      Lazy initialization of local metadata dictionary.

      Returns
      -------
      Dict[str, Any]
          Metadata dictionary



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

      Lazy initialization of local metadata dictionary.

      Returns
      -------
      Dict[str, Any]
          Metadata dictionary



   .. py:method:: mark_event(region_id: str)

      Mark an event for a specific region.

      Parameters
      ----------
      region_id : str
          The ID of the region to mark the event for.

      Returns
      -------
      None



   .. py:method:: monitor_application(app: perun.monitoring.application.Application) -> Any

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

      Parameters
      ----------
      app : Path
          App script file path

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



   .. py:method:: _export_multirun(multirun_node: perun.data_model.data.DataNode)


   .. py:method:: _process_multirun(multirun_nodes: Dict[str, perun.data_model.data.DataNode]) -> perun.data_model.data.DataNode


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

      Import data node from given filepath.

      Parameters
      ----------
      filePath : Path
          Perun data node file path.
      format : IOFormat
          File format.

      Returns
      -------
      DataNode
          Imported DataNode.



   .. py:method:: export_to(dataOut: pathlib.Path, dataNode: perun.data_model.data.DataNode, format: perun.io.io.IOFormat, mr_id: Optional[str] = None)

      Export data to selected format.

      Parameters
      ----------
      dataOut : Path
          Directory where data will be saved.
      dataNode : DataNode
          Data node to export.
      format : IOFormat
          Format to export data.



   .. py:method:: _run_postprocess_callbacks(dataNode: perun.data_model.data.DataNode)