oitg.paths API

Well-known file system paths within the Oxford Ion Trap Quantum Computing group’s computer/network setup.

exception oitg.paths.OitgEnvError[source]

Raised when a value could not be determined from the local machine configuration (OITG_… environment variables).

Not named the more straightforward “EnvironmentError” to avoid confusion with the built-in exception type of the same name.

oitg.paths.default_experiment() → str[source]

Return the default experiment name, as given by the OITG_EXPERIMENT environment variable.

The experiment name matches the corresponding subdirectory of the shared area ARTIQ results directory (e.g. lab1_alice); see artiq_results_path().

oitg.paths.shared_area_path() → str[source]

Return the standard path to the shared area on the current platform.

For Windows, the standard mount point is Z:\, and for Unix-like systems (Linux/macOS) it is ~/steaneShared; this can be overwritten using the OITG_SHARED_AREA environment variable.

oitg.paths.analysis_root_path(user: str | None = None) → str[source]

Return the path to the given users analysis directory on the shared area (<shared_area>/Users/<user>/analysis).

Parameters:

user – The name of the shared-area user directory to target. If None, defaults to the environment variable OITG_USER.

oitg.paths.todays_analysis_path(day: str | None = None, user: str | None = None) → str[source]

Return the path to the analysis directory for the given day, defaulting to today.

The analysis directory is intended to be used as working space for analysing data while it is taken, so that the code can easily be found again later if the data or conclusions reached are reexamined.

If the directory does not exist, it is created.

Parameters:

  • day – The date to use, in ISO format (yyyy-mm-dd), or None for today.

  • user – The name of the shared-area user directory to target; see analysis_root_path().

oitg.paths.artiq_results_path(experiment: str | None = None) → str[source]

Return the path to an experiment’s ARTIQ results directory.

The standard results path is <shared_area>/artiqResults/<experiment>.

Parameters:

experiment – The name of the experimental setup, as per the corresponding subdirectory of the shared area results directory. If None, defaults to the environment variable OITG_EXPERIMENT (see default_experiment()).