This directory contains the formal technical documentation for the Relativity-Simulator.
DESCRIPTION.md
System-level specification, scientific scope, runtime modes, spacetimes, relativistic hydrodynamics, and validation scenarios.
ARCHITECTURE.md
Software architecture, subsystem hierarchy, render pipeline, capture subsystem, profiling, constants engine, concurrency model, scheduling, and precision design.
TECHNICAL_MANUAL.md
Implementation-oriented component overview, design constraints, renderer back ends, metric usage table, integrator selection rules, orchestration, and interface modules.
MATHEMATICAL_FORMULATION.md
Governing equations, metric definitions, geodesics, post-Newtonian terms, relativistic hydrodynamics, polarized transport, uncertainty propagation, ray tracing and disk emission, body shading, and motion script mathematics.
FILE_FORMATS.md
YAML scenario schema, FITS 4.0 images and cubes, custom HDF5 containers, VTK PolyData geometry, SPICE SPK and HORIZONS ingestion, image codecs, capture session structure, telemetry recordings, motion script configuration, and persistent settings.
CLI_REFERENCE.md
Standalone executables, interactive REPL commands, performance presets, navigation modes and keybindings, and headless batch exporter.
TREE.md
Repository layout.