Skip to content

spaceteams.SC_Compute_Server.path_utils

AssetPathAndCategory

AssetPathAndCategory(source_path_no_category: PathLike | str | bytes, category: AssetFileCategory)

category instance-attribute

category: AssetFileCategory

source_path_no_category property writable

source_path_no_category: Path

EnsureUserSpecificDirsExist

EnsureUserSpecificDirsExist() -> None

Ensure that the user-specific directories for assets, configs, output, etc exist.

GetDatasetsDir

GetDatasetsDir() -> pathlib.Path

Get computer-wide dataset directory for this ST version. May not be used yet in versions before or shortly after v0.38.

GetFileCategoryOfAssetSource

GetFileCategoryOfAssetSource(source_path: PathLike | str | bytes) -> AssetPathAndCategory

GetLocalAssetsDir

GetLocalAssetsDir() -> pathlib.Path

Get user-modifiable assets directory. This is the default location for user-saved or user-downloaded assets.

GetLocalConfigDir

GetLocalConfigDir() -> pathlib.Path

Get per-user config directory. User settings files are typically saved here. Usually, you should not need to modify files here manually.

GetLocalLogsDir

GetLocalLogsDir() -> pathlib.Path

Get per-user logs directory. This is the default location for simulation log files from the "logger" AtomicLogger objects. User code may consider using GetLocalOutputDir() instead to ensure user-outputted files don't conflict with the automated logging.

GetLocalOutputDir

GetLocalOutputDir() -> pathlib.Path

Get per-user output directory. This is the default location for output files such as simulation results.

GetPlatformInstallDir

GetPlatformInstallDir() -> pathlib.Path

Get computer-wide install directory for this ST version. May not be used yet in versions before or shortly after v0.38.

GetVersionInstallCacheDir

GetVersionInstallCacheDir() -> pathlib.Path

Get per-user version cache directory. This is used to store things like the spaceteams python virtual environment.