pyfebiopt.monitoring.paths

Helpers to resolve default directories used by the monitoring components.

Functions

default_runtime_dir(→ pathlib.Path)

Resolve the directory used for runtime sockets and locks.

default_data_dir(→ pathlib.Path)

Determine the directory for persistent monitoring data.

default_socket_path(→ pathlib.Path)

Return the default UNIX socket path for the monitor.

default_registry_path(→ pathlib.Path)

Return the default path where completed runs are listed.

Module Contents

pyfebiopt.monitoring.paths.default_runtime_dir() pathlib.Path

Resolve the directory used for runtime sockets and locks.

Returns:

Directory path for runtime sockets/locks.

Return type:

Path

pyfebiopt.monitoring.paths.default_data_dir() pathlib.Path

Determine the directory for persistent monitoring data.

Returns:

Directory path for persisted monitor data.

Return type:

Path

pyfebiopt.monitoring.paths.default_socket_path() pathlib.Path

Return the default UNIX socket path for the monitor.

pyfebiopt.monitoring.paths.default_registry_path() pathlib.Path

Return the default path where completed runs are listed.