setup_status
Diagnose FreeCAD and solver installations for AnkusDrive, reporting missing components with exact fix commands to complete setup or resolve install issues.
Instructions
The machine-readable form of ankusdrive doctor — resolve FreeCAD and every
solver family and report, per item, found/missing with the exact fix. Call this
when the user asks to set up, diagnose, or finish installing AnkusDrive, then walk
them through the per-item fix/install_hint commands for their platform.
Read-only and side-effect-free: nothing is executed or installed and no
environment is mutated (verify_freecad_boot=True additionally boots FreeCAD
once, time-boxed, purely to read back its version — leave it False unless the
user doubts the install actually runs).
Returns {platform: {system, machine}, freecad: {available, path, source,
version?, fix?}, install: {kind, source} (venv | pipx | uv_tool | uvx | mcpb —
the install every fix string is written for), solvers: {available, unwired, prepared_case_only, solvers:
{name: {..., install_hint | wire_hint}}, families: {family: {solvers, available,
unwired, prepared_case_only, any_available}}, extras}} —
families[*].any_available is what gates each *_submit family, and every
unavailable item carries its own fix string. A solver under
prepared_case_only resolves but no AnkusDrive tool can build it a case, so it
does not make its family available (SU2/cfd — issue #237).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verify_freecad_boot | No |