qblox_scheduler.data_dir#

Data handling utilities for Qblox Scheduler.

Classes#

OutputDirectoryManager

Manages output directory paths for Qblox Scheduler data storage.

Functions#

_get_default_datadir(→ pathlib.Path)

Returns (and optionally print) a default datadir path.

Module Contents#

_get_default_datadir(verbose: bool = False) → pathlib.Path[source]#

Returns (and optionally print) a default datadir path.

Intended for fast prototyping, tutorials, examples, etc..

Parameters:

verbose – If True prints the returned datadir.

Returns:

: The Path.home() / "qblox_data" path.

class OutputDirectoryManager[source]#

Manages output directory paths for Qblox Scheduler data storage.

The class maintains a single instance throughout the application lifecycle, ensuring consistent directory management.

_datadir#

The current data directory path. Private attribute managed through setter and getter methods.

Type:

str or Path

DATADIR: ClassVar[pathlib.Path][source]#
classmethod set_datadir(datadir: pathlib.Path | str | None = None) → None[source]#

Sets the data directory.

Parameters:

datadir (pathlib.Path or str or None) – Path of the data directory. If set to None, resets the datadir to the default datadir (<top_level>/data).

classmethod get_datadir() → pathlib.Path[source]#

Returns the current data directory.

Returns:

: The current data directory.