Skip to content

Home

Jump to bottom
Test User edited this page May 14, 2026 · 9 revisions

astrodyn wiki

Project documentation. Most docs live here; the only doc that stays in the repo is JEOD_invariants.md (tagged in source as // JEOD_INV: XX.YY, so it has to live next to the code).

Pre-release audit

Originally anchored at commit 587e2e7 (April 2026). Re-anchored at 7619f2f (May 2026) after the workspace rebrand to astrodyn (#387), the AstrodynPlugin/AstrodynSet rename (#392), the runner ↔ Bevy parity bridge (#389), the gateway-only physics dep enforcement (#390), and the typed-construction discipline at the public surface (#397). The matrix and gap list reflect that tree.

  • JEOD-Capability-Matrix — master cross-reference of every JEOD v5.4 capability against its astrodyn counterpart. Rows cover the full set of JEOD models, verification SIMs (with per-RUN expansion), data files, and mission benchmarks. Every tier3_* test is listed in the row it covers.
  • JEOD-Sim-Coverage — per-SIM, per-RUN coverage map for the full set of JEOD production SIMs. Each "covered" claim verified by reading both the JEOD input.py config and the corresponding astrodyn_verif_jeod tier3 test source. Distinguishes JEOD-CSV cross-validation from analytical-only coverage.
  • Audit-Findings — prioritized gap list derived from the matrix (i.e. "what JEOD capabilities are still missing"). The original audit's release-blockers triaged at 587e2e7 (10 items) and doc/discoverability bucket (4 items) have been worked down: B1.1, B1.2, B1.8, B1.9, and B2.3 are closed; the page lists the open items only.
  • Audit-2026-05 — comprehensive findings audit (May 2026, anchored at 47b8902). Surveys architecture, type-system rigor, error handling, JEOD invariants, testing, performance, dependencies, and CI. 5 High + 12 Medium findings filed as sub-issues of #487 under label audit-2026-05. Includes risk register, strengths-worth-preserving inventory, and a 1.0-readiness roadmap.

Architecture and contributor docs

  • Strategy — architecture, three-layer structure (astrodyn_* physics, astrodyn gateway, astrodyn_bevy ECS adapter), and phase history (Phases 1–8 + Type-System refactor).
  • Type-System — phantom-tag pattern primer; how to read compile-time physics errors, add a new frame/scale/quantity, escape hatches.
  • Dependency-Graph — workspace dep graph (Mermaid + textual edge listing); production-path slice that published consumers see.
  • Integration-Groups — how JEOD's JeodIntegrationGroup maps onto Bevy's FixedUpdate schedule; multi-stage integrators, multi-body sims, and the escape hatch for separate groups.
  • Frame-Tree-ECS-Native — frame-tree refactor design + landed-PR record (#198/#206/#263/#280/#299/#308/#312/#314/#319/#350/#357/#358/#363/#381). Useful as the historical execution log; the runtime model is summarized in Strategy.
  • Tier3-Regeneration — regenerating Tier 3 reference CSVs in Docker. Includes the cargo xtask regenerate-tier3 wrapper, the explicit docker run invocation, troubleshooting, and the CSV column layout.
  • JEOD-Source-Data — navigating the upstream JEOD source tree and what numerical test vectors are extractable. Catalogs the per-crate extract_* binaries and the parsability tiers of JEOD's Modified_data Python files.
  • Numerical-Differences — catalogued irreducible differences between astrodyn and JEOD outputs, with rationale.
  • Earth-Lighting-Validation — shadow-geometry validation notes for the earth_lighting model.
  • Variable-Server — design-only spec for a future Bevy-native variable server (bevy_var_server). Not implemented; preserved as the contract a future implementation should hold itself to.

In-repo reference

  • JEOD_invariants.md — 68-row catalog of JEOD runtime invariants, tagged in source as // JEOD_INV: XX.YY. Stays in the repo because the catalog and the source tags are consistency-checked together.

Clone this wiki locally