AssetPathAndCategory(source_path_no_category: PathLike | str | bytes, category: AssetFileCategory)
EnsureUserSpecificDirsExist() -> None
Ensure that the user-specific directories for assets, configs, output, etc exist.
GetFileCategoryOfAssetSource(source_path: PathLike | str | bytes) -> AssetPathAndCategory
GetLocalAssetsDir() -> pathlib.Path
Get user-modifiable assets directory. This is the default location for user-saved or user-downloaded assets.
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() -> 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() -> pathlib.Path
Get per-user output directory. This is a good location for output files which need to be reused by another simulation.
GetRunLogsDirFromUUID(sim_run_uuid: UUID) -> pathlib.Path | None
Get per-run logs directory from sim-run UUID. This is the directory for the sim's .log files. Returns None if the dir for the run UUID does not exist.
GetRunOutputDirFromUUID(sim_run_uuid: UUID) -> pathlib.Path | None
Get per-run output directory from sim-run UUID. This is the directory for the sim's output files such as saved telemetry images, plots, etc. Returns None if the dir for the run UUID does not exist.
GetVersionInstallCacheDir() -> pathlib.Path
Get per-user version cache directory. This is used to store things like the spaceteams python virtual environment.
Internal_GetOrCreateRunOutputDirs(sim_run_uuid: UUID, run_name: str) -> pathlib.Path
Internal-use function to create the output dirs for a certain sim run UUID and name.