API reference

Setup workflow

Signatures, parameters, return contracts, and source for setup workflow.

Overview

Setup planning separates the declared installation/download/conversion steps from execution. Default setup creates local directories and installs the checkout; downloads occur only when explicitly requested. A dry run prints the plan without executing its commands.

Source revision: caef7be03abd. Public export index.

DatasetSpec

axosim.setup_workflow.DatasetSpec(name: str, slug: str)

Source

Kaggle dataset identity and its local directory name.

Parameters

name str
required. Local dataset subdirectory and archive name.
slug str
required. Kaggle owner/dataset identifier passed to the downloader.

Attributes

Constructor fields are retained as read-only attributes.

SetupOptions

axosim.setup_workflow.SetupOptions(project_root: Path, data_dir: Path, install_kaggle: bool = False, download_data: bool = False, convert_raw: bool = False, raw_dir: Path | None = None, shard_dir: Path | None = None, shard_size: int = 128, skip_install: bool = False, datasets: tuple[DatasetSpec, ...] = DEFAULT_DATASETS, python_executable: str = sys.executable)

Source

Installation, download, conversion, and path choices used to construct a setup plan.

Parameters

project_root Path
required. Source checkout containing the package to install and local run directories.
data_dir Path
required. Root of the raw-data and shard directories.
install_kaggle bool
default=False. Include installation of downloader dependencies in the plan.
download_data bool
default=False. Include explicit dataset downloads in the plan.
convert_raw bool
default=False. Include raw NeuronIO conversion in the plan.
raw_dir Path | None
default=None. Optional raw-data directory overriding data_dir/raw.
shard_dir Path | None
default=None. Optional converted-data directory overriding data_dir/shards.
shard_size int
default=128. Maximum sample count in each converted shard.
skip_install bool
default=False. Omit editable package installation from the plan.
datasets tuple[DatasetSpec, ...]
default=DEFAULT_DATASETS. Kaggle dataset identities to download when download_data is enabled.
python_executable str
default=sys.executable. Interpreter used for planned installation, download, and conversion commands.

Attributes

Constructor fields are retained as read-only attributes.

SetupStep

axosim.setup_workflow.SetupStep(description: str, command: str | None = None, argv: tuple[str, ...] | None = None, mkdir: Path | None = None)

Source

One directory-creation or subprocess step with a reader-facing description.

Parameters

description str
required. Reader-facing description of the setup operation.
command str | None
default=None. Shell-quoted display of the planned subprocess arguments.
argv tuple[str, ...] | None
default=None. Argument tuple passed directly to the planned subprocess.
mkdir Path | None
default=None. Directory created by this step, when provided.

Attributes

Constructor fields are retained as read-only attributes.

SetupPlan

axosim.setup_workflow.SetupPlan(steps: tuple[SetupStep, ...], next_steps: tuple[str, ...] = field(default_factory=tuple))

Source

Ordered setup operations and follow-up commands.

Parameters

steps tuple[SetupStep, ...]
required. Ordered setup operations.
next_steps tuple[str, ...]
default=field(default_factory=tuple). Follow-up instructions printed after the plan.

Attributes

Constructor fields are retained as read-only attributes.

build_setup_plan

axosim.setup_workflow.build_setup_plan(options: SetupOptions) -> SetupPlan

Source

Construct the setup operations without executing installations, downloads, or conversions.

Parameters

options SetupOptions
required. Setup flags and resolved local paths used to construct the plan.

Returns

plan SetupPlan
Ordered directory-creation and subprocess steps plus follow-up instructions; no steps have run.

run_setup_plan

axosim.setup_workflow.run_setup_plan(plan: SetupPlan, *, dry_run: bool=False) -> None

Source

Print and execute each planned operation; dry_run prints the same plan without filesystem or subprocess changes.

Parameters

plan SetupPlan
required. Ordered setup steps and next-step instructions to execute or inspect.
dry_run bool
keyword-only, default=False. Print the plan without creating directories or executing subprocesses.

Returns

result None
No return value.

Search guides, examples, and API signatures.