How aerosim-open/aerosim works
Primary components
• Core Simulation Engine: Represented by the Python package (aerosim) with its sub-modules such as core (simulation logic, configuration, simulation loop), io (input handlers, WebSockets servers), and visualization (camera, flight display, etc.).
• aerosim-controllers: Contains various flight control systems (e.g., autopilot, flight controller, primary flight display controller) and FMU build scripts.
• aerosim-core: Implements core simulation utilities, math operations, coordinate system conversions, and simulation actor definitions.
• aerosim-data: Manages data types, middleware interfaces (with examples for DDS, Kafka, ROS2), and FMU interface components.
• aerosim-dynamics-models: Contains aircraft dynamics, actuator models, and FMU build utilities for dynamics.
• aerosim-scenarios: Contains simulation scenarios, configurations, and translators to drive specific missions or test cases.
• aerosim-sensors: Provides sensor models (e.g., ADS-B, GNSS, IMU) and FMU build scripts for sensor emulation.
• aerosim-world & aerosim-world-link: Represent the simulation world, orchestration, and the interfacing layer between Rust and Python, including simulation management, logging, scene graph, and clock management.
• aerosim-macros: Likely contains Rust macros used by several other Rust crates.
• Renderers & Frontend:
• aerosim-app: A separate React/TypeScript application that serves as the visualization and control UI.
• aerosim-unreal-project and aerosim-omniverse-kit-app (as referenced in the README): Components for high-fidelity visualization using Unreal Engine and Omniverse.
Out relationships and data flows
• Data Flow & Communication:
• FMU interactions should also be explicitly represented; show how various FMU models (from controllers, dynamics, sensors) plug into the simulation—this can be depicted via connectors between FMU components and the main simulation module.
Architectural Patterns & Components
• At the bottom, group together the lower-level Rust crates (controllers, core, data, dynamics-models, sensors, scenarios, world, macros). They form the simulation “engine” foundations.
• At the top, include external and visualization components like the aerosim-app UI, Unreal Engine, and Omniverse interfaces.
• Design principles such as modularity (each Rust crate is independently developed yet integrated) and separation of concerns (distinct modules for simulation logic, data handling, UI integration, and FMU interfacing).