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)
Kaggle dataset identity and its local directory name.
Parameters
namestr- required. Local dataset subdirectory and archive name.
slugstr- 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)
Installation, download, conversion, and path choices used to construct a setup plan.
Parameters
project_rootPath- required. Source checkout containing the package to install and local run directories.
data_dirPath- required. Root of the raw-data and shard directories.
install_kagglebool- default=False. Include installation of downloader dependencies in the plan.
download_databool- default=False. Include explicit dataset downloads in the plan.
convert_rawbool- default=False. Include raw NeuronIO conversion in the plan.
raw_dirPath | None- default=None. Optional raw-data directory overriding data_dir/raw.
shard_dirPath | None- default=None. Optional converted-data directory overriding data_dir/shards.
shard_sizeint- default=128. Maximum sample count in each converted shard.
skip_installbool- default=False. Omit editable package installation from the plan.
datasetstuple[DatasetSpec, ...]- default=DEFAULT_DATASETS. Kaggle dataset identities to download when download_data is enabled.
python_executablestr- 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)
One directory-creation or subprocess step with a reader-facing description.
Parameters
descriptionstr- required. Reader-facing description of the setup operation.
commandstr | None- default=None. Shell-quoted display of the planned subprocess arguments.
argvtuple[str, ...] | None- default=None. Argument tuple passed directly to the planned subprocess.
mkdirPath | 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))
Ordered setup operations and follow-up commands.
Parameters
stepstuple[SetupStep, ...]- required. Ordered setup operations.
next_stepstuple[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
Construct the setup operations without executing installations, downloads, or conversions.
Parameters
optionsSetupOptions- required. Setup flags and resolved local paths used to construct the plan.
Returns
planSetupPlan- 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
Print and execute each planned operation; dry_run prints the same plan without filesystem or subprocess changes.
Parameters
planSetupPlan- required. Ordered setup steps and next-step instructions to execute or inspect.
dry_runbool- keyword-only, default=False. Print the plan without creating directories or executing subprocesses.
Returns
resultNone- No return value.