chronaxis.validate_analysis_plan

Import this object from chronaxis. This page covers its 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.

`validate_analysis_plan`

Report static configuration validity and the currently supported reading, execution, and publication capabilities.

python

validate_analysis_plan(plan: AnalysisPlan) -> ValidationReport

Name	Type	Required	Default	Purpose, choices, and effect
`plan`	AnalysisPlan	Yes	No default	Positional or keyword. A checked plan from `load_analysis_plan("analysis.yaml")` or `AnalysisPlan.from_dict(config)`, not a YAML filename string.

Returns ValidationReport (Chinese implementation reference). A valid, supported plan has valid=True and empty errors. warnings retains unverified fields, observation ranges, and unit status; capability_status describes available execution support. execution_ready reflects static capability errors, not proof of data being read or adequate real RAM.

Raises TypeError when input is not an AnalysisPlan (message: “validate_analysis_plan需要AnalysisPlan。”). Configuration construction errors are reported by the construction entry point first.

No source-reading side effects. Does not recheck CSV, BLF/DBC, actual fields, or physical measurement meanings.

python

from chronaxis import load_analysis_plan, validate_analysis_plan
plan = load_analysis_plan("Docs/Current/examples/analysis.yaml")
report = validate_analysis_plan(plan)
print(report.valid, report.execution_ready)

Source locations

src/chronaxis/planning/reports.py:287 — line at 8904c2f744951857659abd40aaa3535d57faf53c.