Skip to content

docs(rfc): RFC 0003 — SUAVE dependency isolation - #40

Closed
aligatoralex wants to merge 1 commit into
mainfrom
docs/rfc-suave-isolation
Closed

aligatoralex wants to merge 1 commit into
mainfrom
docs/rfc-suave-isolation

Conversation

@aligatoralex

Copy link
Copy Markdown
Contributor

Description of Changes:

Adds docs/rfc/0003-suave-dependency-isolation.md — an RFC on how YAADO should depend on SUAVE, based on the hands-on install in PR #33. No code changes.

Key points for review:

  • SUAVE 2.5.2 needs --no-build-isolation + three runtime shims and must stay out of the uv-locked env.
  • Options: dedicated venv + a maintained suave_compat shim module (recommended now), baked container/devcontainer (later), vendoring patches into the submodule (rejected — pinned submodule).
  • CI implication: the [FEATURE] Update VehicleFactory to support vehicle-agnostic ComponentStore architecture #29 SUAVE-gated test needs its own job (submodule checkout + shimmed venv), and staying SKIPPED in the shared env is the correct default until then.
  • Flags that the scipy.misc.derivative shim is not yet numerically validated.

Checklist:

  • I have run uv run pytest YAADO_Core/tests/ and all tests pass. (Docs-only.)
  • My code includes type hints and docstrings. (N/A — Markdown RFC.)
  • I added all vital READMEs. (Adds to docs/rfc/.)

Verification method:
Every technical claim traces to the reproduced commands/errors in PR #33 (docs/SUAVE_INTEGRATION_NOTES.md).


Generated by Claude Code

Preliminary design proposal (RFC) for how YAADO should depend on SUAVE
2.5.2, based on the hands-on install findings in PR #33: it needs
--no-build-isolation plus three runtime shims and must stay out of the
uv-locked env. Proposes a dedicated venv + a maintained suave_compat shim
module (turning the exploration monkeypatches into tested code) now, a
baked container later, and a separate CI job for the #29 gated test.
Rejects vendoring patches into the pinned submodule. For team review.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NPJaUV26PzaRdYKr3Q7z1d

Copy link
Copy Markdown
Contributor Author

Superseded by #47 — this RFC's content moves unchanged to docs/rfcs/0003-suave-dependency-isolation.md as part of a consolidation of all docs-only RFC/notes PRs into one PR (see #47 for rationale). Discussion stays on issue #41. Closing this PR; its branch will be deleted.


Generated by Claude Code

@aligatoralex
aligatoralex deleted the docs/rfc-suave-isolation branch September 1, 2026 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants