qudi.util.paths

ToDo: Throw errors around for non-existent directories

Functions

`get_appdata_dir`([create_missing])	Get the system-specific application data directory.
`get_default_config_dir`([create_missing])	Get the system-specific application data directory.
`get_default_log_dir`([create_missing])	Get the system-specific application log directory.
`get_default_data_dir`([create_missing])	Get the system-specific application fallback data root directory.
`get_daily_directory`([timestamp, root, ...])	Returns a path tree according to the timestamp given.
`get_home_dir`()	Returns the absolute path to the home directory.
`get_main_dir`()	Returns the absolute path to the directory of the main software.
`get_userdata_dir`([create_missing])	Returns the absolute path to the Qudi subfolder in the user home directory.
`get_artwork_dir`()	Returns the absolute path to the Qudi artwork directory.
`get_module_app_data_path`(cls_name, ...)	Constructs the appData file path for the given qudi module

qudi.util.paths.get_appdata_dir(create_missing: bool | None = False) → str[source]

Get the system-specific application data directory.

Returns:

str: Path to the application data directory specific to the system.

qudi.util.paths.get_artwork_dir() → str[source]

Returns the absolute path to the Qudi artwork directory.

Returns:

str: Path to the artwork directory of Qudi.

qudi.util.paths.get_daily_directory(timestamp: datetime | None = None, root: str | None = None, create_missing: bool | None = False) → str[source]

Returns a path tree according to the timestamp given.

The directory structure will have the form: root/<YYYY>/<MM>/<YYYY-MM-DD> If no root directory is given, this method will return just the relative path stub: <YYYY>/<MM>/<YYYY-MM-DD>

Parameters:

timestampdatetime.datetime, optional: Timestamp for which to create the daily directory. Defaults to current timestamp if not provided.
rootstr, optional: Root path for the daily directory structure. If not provided, only the relative path stub is returned.
create_missingbool, optional: Indicates if the directory should be created (True) or not (False). Only considered if root is given.

Returns:

str: Path representing the directory structure based on the timestamp.

qudi.util.paths.get_default_config_dir(create_missing: bool | None = False) → str[source]

Get the system-specific application data directory.

Returns:

str: Path to the application data directory specific to the system.

qudi.util.paths.get_default_data_dir(create_missing: bool | None = False) → str[source]

Get the system-specific application fallback data root directory. This function does NOT consider Qudi configuration.

Returns:

str: Path to the default data root directory specific to the system.

qudi.util.paths.get_default_log_dir(create_missing: bool | None = False) → str[source]

Get the system-specific application log directory.

Returns:

str: Path to the default logging directory specific to the system.

qudi.util.paths.get_home_dir() → str[source]

Returns the absolute path to the home directory.

Returns:

str: Absolute path to the home directory.

qudi.util.paths.get_main_dir() → str[source]

Returns the absolute path to the directory of the main software.

@return string: path to the main tree of the software

qudi.util.paths.get_module_app_data_path(cls_name: str, module_base: str, module_name: str) → str[source]: Constructs the appData file path for the given qudi module

qudi.util.paths.get_userdata_dir(create_missing: bool | None = False) → str[source]

Returns the absolute path to the Qudi subfolder in the user home directory. This path should be used for exposed user data like config files, etc.

Returns:

str: Absolute path to the Qudi subfolder in the user home directory.