API stability

This page describes the public API surface of QF Solver 0.2.11.

Public namespace

New integrations should import from qf_solver:

from qf_solver import check_mesh, load_model, save_result, solve_model

The standard flow is load_model -> check_mesh -> solve_model -> save_result. The complete symbol inventory, signatures, stability categories, and exception contract are maintained in the qf_solver API contract. The package version is available without importing implementation modules:

from qf_solver import __version__
print(__version__)

The solveur namespace remains a compatibility facade for existing 0.2.x applications. The recommended CLI is qf-solver; legacy entry points remain available during the 0.2.x compatibility period. The current compatibility plan schedules removal of the legacy solveur-ef launcher for 0.3.0; this is a plan, not a 0.2.11 removal.

Compatibility boundary

JSON v1 inputs remain supported where the documented schema permits them. CLI commands and stable exit codes are part of the public interface. Interface stability does not qualify every element, analysis or material combination; the active 0.2.8 consolidated registry and separate mixed-workflow/capability records define those boundaries.

qf_solver.read_inp(path) remains PROVISIONAL; it covers only the documented bounded Abaqus/CalculiX subset and is not a full-format compatibility claim.

Version 0.2.11 contains rotating_modal and campbell JSON routes with EXPERIMENTAL maturity. They are not part of the published 0.2.10 API contract. Their complex result schemas are provisional and must not be treated as stable for downstream integrations. Package publication does not promote numerical maturity or schema stability. See the rotating-modal scope and Campbell scope.

The family-aware mixed HDF5 functions are also PROVISIONAL and EXPERIMENTAL_BOUNDED: they cover the documented schema-v1.0 TET4/WEDGE6/HEX8 result-storage path only. Internal implementation symbols under solveur are not stable API exports unless listed in the API contract.