docs: SUAVE 2.5.2 install/integration notes (feasibility + API validation) - #33
Closed
aligatoralex wants to merge 1 commit into
Closed
aligatoralex wants to merge 1 commit into
aligatoralex wants to merge 1 commit into
Conversation
Document a hands-on attempt to install and import SUAVE 2.5.2 (the pinned external/suave submodule) into an isolated venv, kept entirely out of the project's uv environment. Records: - The three unavoidable Python-3.11/modern-scipy incompatibilities on SUAVE's eager import chain (vendored pint's collections.MutableMapping, removed scipy.integrate.cumtrapz and scipy.misc.derivative) and the runtime shims that work around them without editing the pinned submodule, plus the --no-build-isolation requirement for `pip install -e`. - Direct validation of the real SUAVE API surface the VehicleFactory (#29) translator relies on: zero mismatches; Turbojet_Super/Ramjet/Liquid_Rocket/ Scramjet all present; no solid-motor network exists, confirming the translator's NotImplementedError for SolidMotor. The #29 SUAVE-gated integration test passes against the real install (3/3). - A recommendation to keep SUAVE in a dedicated venv/container behind a small maintained suave_compat shim rather than adding it to pyproject.toml, with the CI implications. Exploration/reference material for onboarding; changes no code paths. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NPJaUV26PzaRdYKr3Q7z1d
This was referenced Aug 31, 2026
Contributor
Author
|
Superseded by #47 — consolidated all docs-only RFC/notes PRs into a single Generated by Claude Code |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of Changes:
Adds
docs/SUAVE_INTEGRATION_NOTES.md— a hands-on report from actually installing SUAVE 2.5.2 (the pinnedexternal/suavesubmodule) into an isolated venv, kept entirely out of the project'suvenvironment (pyproject.toml/uv.lockuntouched, submodule untouched). Created in response to the question "why not just install SUAVE?" — the answer, with evidence.Key findings:
pip install -eneeds--no-build-isolation(SUAVE'ssetup.pyeagerlyimport numpys at build-requirement time), andimport SUAVEthen needs three runtime shims applied first — all on SUAVE's eager import chain, so unavoidable:collections.MutableMappingalias (SUAVE's vendoredpint, broken on Python ≥3.10 — every interpreter on this box).scipy.integrate.cumtrapz→cumulative_trapezoid(a genuine drop-in).scipy.misc.derivative— removed with no drop-in; a central-difference stand-in that unblocks the import but is not numerically validated.VehicleFactoryto support vehicle-agnostic ComponentStore architecture #29) API validated against the real package — zero mismatches.Turbojet_Super,Ramjet,Liquid_Rocket,Scramjetall exist;Wing.sweeps/spans/taper/aspect_ratio/dihedral/verticalall present with the expected shapes. A solid-motor network is confirmed genuinely absent, which validates the translator'sNotImplementedErrorforSolidMotor.VehicleFactoryto support vehicle-agnostic ComponentStore architecture #29 SUAVE-gated integration test passes on the real install (3/3) — inspected viagit archivefromfeature/vehicle-factory-compositionwithout ever switching the repo branch.suave_compatshim (turning this exploration's monkeypatches into tested code), neveruv add'd intopyproject.toml; plus the CI implications for the gated test.This validates PR #30 (VehicleFactory) end-to-end against a real SUAVE and turns "why not install SUAVE" into a documented dependency-isolation decision.
Checklist:
uv run pytest YAADO_Core/tests/and all tests pass. (Docs-only; the projectuvenv was deliberately left untouched — SUAVE went into a throwaway venv.)docs/.)Verification method:
Every claim in the report comes from commands actually run in the isolated venv (exact error messages and the successful import/test output are reproduced in the doc). The API surface was probed directly against the installed
SUAVE 2.5.2; the gated#29test was executed against it (3 passed).Generated by Claude Code