larvaworld.portal.workspace

Attributes

`WorkspaceKind`
`WORKSPACE_DIR_NAMES`
`WORKSPACE_METADATA_FILENAME`
`GLOBAL_CONFIG_FILENAME`
`WORKSPACE_SCHEMA_VERSION`

Exceptions

WorkspaceError

Raised when the active workspace is missing or invalid.

Classes

`WorkspaceValidation`
`WorkspaceState`

Functions

`read_global_workspace_config`(→ dict[str, object])
`write_global_workspace_config`(→ None)
`get_active_workspace_path`(→ pathlib.Path \| None)
`set_active_workspace_path`(→ pathlib.Path)
`clear_active_workspace_path`(→ None)
`read_workspace_metadata`(→ dict[str, object])
`write_workspace_metadata`(→ None)
`validate_workspace`(→ WorkspaceValidation)
`initialize_workspace`(→ WorkspaceState)
`load_workspace`(→ WorkspaceState)
`get_active_workspace`(→ WorkspaceState \| None)
`require_active_workspace`(→ WorkspaceState)
`get_workspace_dir`(→ pathlib.Path)
`get_notebook_workspace_dir`(→ pathlib.Path)

Module Contents

larvaworld.portal.workspace.WorkspaceKind

larvaworld.portal.workspace.WORKSPACE_DIR_NAMES: dict[WorkspaceKind, str]

larvaworld.portal.workspace.WORKSPACE_METADATA_FILENAME = 'workspace.json'

larvaworld.portal.workspace.GLOBAL_CONFIG_FILENAME = 'workspace.json'

larvaworld.portal.workspace.WORKSPACE_SCHEMA_VERSION = 1

exception larvaworld.portal.workspace.WorkspaceError

Bases: RuntimeError

Raised when the active workspace is missing or invalid.

class larvaworld.portal.workspace.WorkspaceValidation

path: pathlib.Path

exists: bool

is_dir: bool

writable: bool

initialized: bool

missing_dirs: list[str]

errors: list[str]

class larvaworld.portal.workspace.WorkspaceState

root: pathlib.Path

name: str

metadata_path: pathlib.Path

environments_dir: pathlib.Path

experiments_dir: pathlib.Path

datasets_dir: pathlib.Path

analysis_dir: pathlib.Path

metadata_dir: pathlib.Path

larvaworld.portal.workspace.read_global_workspace_config() → dict[str, object]

larvaworld.portal.workspace.write_global_workspace_config(data: dict[str, object]) → None

larvaworld.portal.workspace.get_active_workspace_path() → pathlib.Path | None

larvaworld.portal.workspace.set_active_workspace_path(path: str | pathlib.Path) → pathlib.Path

larvaworld.portal.workspace.clear_active_workspace_path() → None

larvaworld.portal.workspace.read_workspace_metadata(path: str | pathlib.Path) → dict[str, object]

larvaworld.portal.workspace.write_workspace_metadata(path: str | pathlib.Path, data: dict[str, object]) → None

larvaworld.portal.workspace.validate_workspace(path: str | pathlib.Path) → WorkspaceValidation

larvaworld.portal.workspace.initialize_workspace(path: str | pathlib.Path, *, name: str | None = None) → WorkspaceState

larvaworld.portal.workspace.load_workspace(path: str | pathlib.Path) → WorkspaceState

larvaworld.portal.workspace.get_active_workspace() → WorkspaceState | None

larvaworld.portal.workspace.require_active_workspace() → WorkspaceState

larvaworld.portal.workspace.get_workspace_dir(kind: WorkspaceKind, *, workspace: WorkspaceState | None = None) → pathlib.Path

larvaworld.portal.workspace.get_notebook_workspace_dir(*, workspace: WorkspaceState | None = None) → pathlib.Path