chronaxis.BatchPlan

Import this object from chronaxis. This page covers directly public members and necessary construction/context protocols. See the Chinese implementation reference for internals. Return to the public API index. Check required parameters, defaults, returns, and exceptions before calling.

`BatchPlan`

Store batch configuration for independent plans. Do not split one continuous session into separate time jobs.

python

BatchPlan(jobs: tuple[chronaxis.batch.models.BatchJob, ...], process_count: int = 1, fail_fast: bool = False, backend: str | None = None) -> None

Name	Type	Required	Default	Purpose, choices, and effect
`jobs`	tuple[BatchJob, ...]	Yes	No default	Job tuple, such as `(BatchJob("a", Path("a.yaml")),)`, or loaded from YAML. Its order determines final report order.
`process_count`	int	No	1	Positive maximum analysis-worker count. Fewer jobs use fewer workers; an empty batch starts none. Excludes the scheduler and CAN reader subprocesses.
`fail_fast`	bool	No	False	False continues other independent jobs after failure. True stops new dispatch; started jobs finish through the batch executor's cancellation cleanup.
`backend`	str \| None	No	None	`auto` selects reference or numpy independently for each job; explicit `reference` or `numpy` fixes the numerical implementation. None preserves each plan's setting. See execution settings.

`BatchPlan.from_dict`

Validate batch configuration. Jobs retain paths; templates are read and expanded into file sets.

python

BatchPlan.from_dict(config, *, base_dir=None)

Class method.

Name	Type	Required	Default	Purpose, choices, and effect
`config`	dict[str, object]	Yes	No default	Positional or keyword. `batch_version=1`; choose either `jobs` or `template` plus `inputs`. Each jobs entry requires plan; omitted name becomes `job_N` by position. Multiple-source templates need `source` to identify the target. Optional process_count, fail_fast, backend. See batch tasks.
`base_dir`	str \| pathlib.Path \| None	No	None	Keyword-only directory for resolving relative paths. None means the current working directory.

Returns a frozen BatchPlan. Raises PlanValidationError identifying invalid fields, duplicate names, missing template inputs, or source ambiguity. Jobs may be empty. Jobs retain plan paths; template mode reads the template, expands inputs, and reads DBC metadata if needed, but does not scan business-message records.

Source locations

src/chronaxis/batch/models.py:58 — line at 8904c2f744951857659abd40aaa3535d57faf53c.
src/chronaxis/batch/models.py:80 — line at 8904c2f744951857659abd40aaa3535d57faf53c.