cli¶
The vr-foraging-packaging command. One subcommand per pipeline function:
session, batch, aggregate.
cli
¶
The vr-foraging-packaging command: one subcommand per pipeline function.
session --input-dir <one raw session> --output-dir <dest>
batch --input-dir <folder of sessions> --output-dir <dest>
aggregate --input-dir <a sessions/ tree> --output-dir <dest>
Every flag maps onto a parameter of the function the subcommand names; the only logic here is rejecting combinations that cannot work.
SessionCommand
¶
Bases: _ProcessingCommand
Export ONE raw session directory.
--input-dir is the session root itself, not a folder containing sessions.
Outputs land directly in --output-dir (no sessions/ level), because
there is only one session to keep apart.
Source code in src/aind_behavior_vr_foraging_packaging/pipeline/cli.py
BatchCommand
¶
Bases: _ProcessingCommand
Export a FOLDER of raw session directories, then aggregate.
--input-dir is scanned one level deep: every immediate subdirectory is
taken to be one raw session. Per-session outputs go to
--output-dir/sessions/{session_id}/, experiment-level files to
--output-dir itself.
Source code in src/aind_behavior_vr_foraging_packaging/pipeline/cli.py
workers = 1
class-attribute
instance-attribute
¶
Number of parallel threads for the per-session phase. 1 = sequential.
clean = True
class-attribute
instance-attribute
¶
Delete --output-dir before writing, so a re-run never mixes two invocations.
skip_aggregation = False
class-attribute
instance-attribute
¶
Write only per-session outputs. Aggregate later with the aggregate subcommand.
AggregateCommand
¶
Bases: _Command
Concatenate already-exported sessions into experiment-level tables.
--input-dir is a sessions/ tree — one subdirectory per session, each
holding the parquets a previous session or batch run wrote. Nothing
is re-processed and nothing is deleted, so this is safe to re-run.
Source code in src/aind_behavior_vr_foraging_packaging/pipeline/cli.py
Cli
¶
Bases: BaseSettings
Root parser: dispatches to whichever subcommand was named.