API reference
Setup CLI
Complete options and defaults for axosim-setup.
Usage
axosim-setup --help
Every command and subcommand accepts -h or --help. The option reference below includes exact parser defaults, choices, required arguments, and compatibility options hidden from ordinary help.
The default data directory is <project-root>/data; raw and shard output directories are resolved by the plan. --download-data and --convert-raw are explicit actions. --dry-run prints the commands and directory operations without executing them.
axosim-setup
Parameters
--project-rootPath · default='Path.cwd()'- Source checkout containing the package to install and local run directories.
--data-dirPath · default=None- Root of the raw-data and shard directories.
--dry-runflag · default=False- Print the plan without creating directories or executing subprocesses. Sets dry_run=True.
--skip-installflag · default=False- Omit editable package installation from the plan. Sets skip_install=True.
--install-kaggleflag · default=False- Include installation of downloader dependencies in the plan. Sets install_kaggle=True.
--download-dataflag · default=False- Include explicit dataset downloads in the plan. Sets download_data=True.
--convert-rawflag · default=False- Include raw NeuronIO conversion in the plan. Sets convert_raw=True.
--raw-dirPath · default=None- Optional raw-data directory overriding data_dir/raw.
--shard-dirPath · default=None- Optional converted-data directory overriding data_dir/shards.
--shard-sizeint · default=128- Maximum sample count in each converted shard.