pyfebiopt.monitoring.paths
==========================

.. py:module:: pyfebiopt.monitoring.paths

.. autoapi-nested-parse::

   Helpers to resolve default directories used by the monitoring components.



Functions
---------

.. autoapisummary::

   pyfebiopt.monitoring.paths.default_runtime_dir
   pyfebiopt.monitoring.paths.default_data_dir
   pyfebiopt.monitoring.paths.default_socket_path
   pyfebiopt.monitoring.paths.default_registry_path


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

.. py:function:: default_runtime_dir() -> pathlib.Path

   Resolve the directory used for runtime sockets and locks.

   :returns: Directory path for runtime sockets/locks.
   :rtype: Path


.. py:function:: default_data_dir() -> pathlib.Path

   Determine the directory for persistent monitoring data.

   :returns: Directory path for persisted monitor data.
   :rtype: Path


.. py:function:: default_socket_path() -> pathlib.Path

   Return the default UNIX socket path for the monitor.


.. py:function:: default_registry_path() -> pathlib.Path

   Return the default path where completed runs are listed.