# pegasussimulator/pegasussimulator architecture

> Architecture diagram of the GitHub repository pegasussimulator/pegasussimulator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pegasussimulator/pegasussimulator
- Repository: https://github.com/pegasussimulator/pegasussimulator

## Overview

##### Project type and purpose
- Pegasus Simulator is a simulation framework (an open-source tool) built as an NVIDIA Omniverse/IsaacSim extension.
- It provides a Python API for multi-rotor vehicle dynamics, autopilot integration (PX4, ArduPilot), and custom control interfaces.

##### File structure
- Top level:
- .github, .gitignore, workflows → CI/CD for tests and docs
- docs/ → Sphinx documentation and tutorials
- examples/ → Python scripts and notebooks demonstrating usage
- extensions/pegasus.simulator/pegasus/simulator/… → core code of Omniverse extension
- tools/packman, tools/scripts → packaging and linking scripts
- Core extension layout (extensions/pegasus.simulator/pegasus/simulator):
- assets/Backends, Robots, Worlds → USD assets for simulation
- logic/ → simulation logic: backends, dynamics, sensors, vehicles, people, graphs
- parser/ → YAML/TOML to internal representation parsers
- ui/ → user interface layer (UI delegate & window)
- params.py → configuration management
- extension.py → entry point for Omniverse plugin registration
- tests/ → unit tests
- Examples instantiate the API, build graphs, spawn vehicles, attach sensors, and run autopilot loops.

##### README for additional insights
- Key external dependencies: NVIDIA Omniverse/IsaacSim, PX4-Autopilot, ArduPilot, ROS2 (optional)
- The README emphasizes multi-rotor dynamics, plugin interfaces, Python control, and autopilot integration.

- Clear labels for: Omniverse Engine, Pegasus Plugin submodules, Control Interfaces, External Systems, Examples/Tools
– Configuration files → Parsers → Simulation logic
– Simulation logic → Sensor data → Backends → Autopilots/Python
– Control commands ← Backends ← User Scripts/Autopilots

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Engine
    OmniverseEngine["Omniverse/IsaacSim Engine"]:::external

    %% Core Plugin
    subgraph "Pegasus Extension Plugin" 
        direction TB
        ExtensionEntry["extension.py"]:::core
        click ExtensionEntry "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/extension.py"

        Params["params.py"]:::core
        click Params "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/params.py"

        subgraph "Assets" 
            AssetLoader["Asset Loader\n(USD assets)"]:::core
            click AssetLoader "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/assets"
        end

        subgraph "Parser Modules"
            Parser["Parser\n(YAML/TOML)"]:::core
            click Parser "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/parser"
        end

        subgraph "Simulation Logic"
            direction TB
            subgraph "Core Modules"
                Dynamics["Vehicle Dynamics"]:::core
                click Dynamics "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/dynamics"
                Sensors["Sensor Simulation"]:::core
                click Sensors "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/sensors"
                GraphicalSensors["Graphical Sensors"]:::core
                click GraphicalSensors "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/graphical_sensors"
                Thrusters["Thruster Models"]:::core
                click Thrusters "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/thrusters"
                People["People Simulation"]:::core
                click People "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/people"
                VehicleManager["Vehicle Manager"]:::core
                click VehicleManager "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/vehicle_manager.py"
                PegasusInterface["PegasusInterface\n(Python API)"]:::core
                click PegasusInterface "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/interface/pegasus_interface.py"
            end

            subgraph "Backends"
                BackendCommon["Backend Interface"]:::core
                click BackendCommon "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/backends/backend.py"
                PX4Backend["PX4 MAVLink Backend"]:::core
                click PX4Backend "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/backends/px4_mavlink_backend.py"
                ArduPilotBackend["ArduPilot MAVLink Backend"]:::core
                click ArduPilotBackend "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/backends/ardupilot_mavlink_backend.py"
                ROS2Backend["ROS2 Backend"]:::core
                click ROS2Backend "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/logic/backends/ros2_backend.py"
                Tools["Autopilot Launch Tools"]:::core
                click Tools "https://github.com/pegasussimulator/pegasussimulator/tree/main/extensions/pegasus.simulator/pegasus/simulator/logic/backends/tools"
            end
        end

        subgraph "UI Layer"
            UIDelegate["UI Delegate"]:::core
            click UIDelegate "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/ui/ui_delegate.py"
            UIWindow["UI Window"]:::core
            click UIWindow "https://github.com/pegasussimulator/pegasussimulator/blob/main/extensions/pegasus.simulator/pegasus/simulator/ui/ui_window.py"
        end
    end

    %% External Systems and Clients
    subgraph "Control Interfaces & External Systems"
        direction TB
        Autopilots["PX4/ArduPilot Processes"]:::external
        ROS2Middleware["ROS2 Middleware"]:::external
        UserScripts["Examples & Client Scripts"]:::user
        click UserScripts "https://github.com/pegasussimulator/pegasussimulator/tree/main/examples/"
    end

    subgraph "Support Tools"
        Docs["Documentation & Tutorials"]:::user
        click Docs "https://github.com/pegasussimulator/pegasussimulator/tree/main/docs/"
        CI["CI/CD Workflows"]:::user
        click CI "https://github.com/pegasussimulator/pegasussimulator/tree/main/.github/workflows/"
        Packaging["Packaging & Linking Scripts"]:::user
        click Packaging "https://github.com/pegasussimulator/pegasussimulator/blob/main/tools/scripts/link_app.py"
    end

    %% Connections
    OmniverseEngine -->|registers plugin| ExtensionEntry
    ExtensionEntry -->|"loads assets"| AssetLoader
    ExtensionEntry -->|"reads config"| Params
    Params -->|"provides configs to"| Parser
    Parser -->|"creates objects for"| Dynamics
    Dynamics --> VehicleManager
    Sensors --> VehicleManager
    GraphicalSensors --> VehicleManager
    Thrusters --> VehicleManager
    People --> VehicleManager
    VehicleManager --> PegasusInterface
    PegasusInterface --> Thrusters
    PegasusInterface --> Dynamics
    PegasusInterface --> Sensors

    VehicleManager -->|"uses"| BackendCommon
    BackendCommon --> PX4Backend
    BackendCommon --> ArduPilotBackend
    BackendCommon --> ROS2Backend
    PX4Backend --> Autopilots
    ArduPilotBackend --> Autopilots
    ROS2Backend --> ROS2Middleware
    Tools --> Autopilots

    PegasusInterface -->|"API calls from"| UserScripts
    UserScripts --> PegasusInterface
    UIDelegate --> PegasusInterface
    UIWindow --> PegasusInterface
    UIDelegate --> Dynamics
    UIWindow --> VehicleManager

    %% Styles
    classDef core fill:#D6EAF8,stroke:#3498DB,color:#1B4F72
    classDef external fill:#FADBD8,stroke:#E74C3C,color:#7B241C
    classDef user fill:#D5F5E3,stroke:#27AE60,color:#145A32
```
