JaguarEngine Documentation¶

JaguarEngine

Next-Generation Multi-Domain Physics Simulation Platform

Overview¶

JaguarEngine is a high-performance physics simulation framework designed for defense modeling and simulation (M&S) applications. It supports Air, Land, Sea, and Space domains within a unified architecture, inspired by JSBSim's proven design patterns while leveraging modern C++20 capabilities.

### Multi-Domain Physics Unified framework supporting aircraft, ground vehicles, surface vessels, and spacecraft in a single simulation. ### High Performance Data-oriented design with Structure-of-Arrays (SoA) memory layout, SIMD optimization, and GPU compute acceleration (CUDA, OpenCL, Metal) for real-time execution. ### Accurate Models 6-DOF rigid body dynamics, US Standard Atmosphere 1976, Bekker-Wong terramechanics, MMG ship maneuvering, SGP4/SDP4 orbital propagation. ### Distributed Simulation Complete IEEE 1278.1-2012 DIS and IEEE 1516-2010 HLA RTI federation support for Live-Virtual-Constructive (LVC) integration. ### Machine Learning Neural autopilot systems, ONNX model inference, reinforcement learning environments with Gym-compatible API, and model repository management. ### Cloud Native Auto-scaling cloud burst capability with distributed state synchronization, Raft consensus, and spatial partitioning for massively concurrent simulations. ### XR Ready Full OpenXR integration with spatial audio, haptic feedback, and training scenario management for immersive simulation experiences. ### Digital Thread Complete lifecycle tracking with history store, predictive degradation models, and physics-based failure prediction for digital twin applications. ### Scriptable Python and Lua bindings for rapid prototyping and integration with data science workflows.

Quick Links¶

Getting Started	Reference	Advanced
Installation Guide	API Reference	Architecture
Quick Start Tutorial	Configuration	Custom Models
First Simulation	Python API	Network Integration

Phase 7 Modules
Cloud Burst	Digital Thread	Machine Learning
Federation	GPU Compute	Sensors

Domain Overview¶

Air Domain¶

Coefficient-based aerodynamics with N-dimensional interpolation tables
Turbofan/turbojet propulsion with altitude-Mach corrections
Flight control system with rate limiting and autopilot

Learn more about Air Domain →

Land Domain¶

Bekker-Wong terramechanics for soil-vehicle interaction
Spring-damper suspension with bump stops
Tracked and wheeled vehicle dynamics

Learn more about Land Domain →

Sea Domain¶

Buoyancy with metacentric height stability
MMG (Maneuvering Mathematical Group) hydrodynamics
Pierson-Moskowitz and JONSWAP wave spectra
RAO-based ship motion response

Learn more about Sea Domain →

Space Domain¶

SGP4/SDP4 orbital propagation
High-fidelity gravity models (J2, J4, EGM96)
Atmospheric drag (JBH08 model)

Learn more about Space Domain →

Installation¶

# Clone the repository
git clone https://github.com/jaguarcode/JaguarEngine.git
cd JaguarEngine

# Build
mkdir build && cd build
cmake ..
make -j$(nproc)

# Run tests
./jaguar_unit_tests

Complete installation guide →

Basic Usage¶

#include <jaguar/jaguar.h>

int main() {
    using namespace jaguar;

    // Create and initialize engine
    interface::Engine engine;
    engine.initialize();

    // Create an aircraft entity
    EntityId aircraft = engine.create_entity("F16", Domain::Air);

    // Set initial state
    physics::EntityState state;
    state.position = Vec3{0.0, 0.0, -10000.0};  // 10 km altitude
    state.velocity = Vec3{250.0, 0.0, 0.0};     // 250 m/s forward
    state.mass = 12000.0;
    engine.set_entity_state(aircraft, state);

    // Run simulation
    for (int i = 0; i < 1000; ++i) {
        engine.step(0.01);  // 100 Hz
    }

    engine.shutdown();
    return 0;
}

View more examples →

Project Status¶

Component	Status	Version
Core Engine	Stable	0.5.0
Air Domain	Stable	Complete
Land Domain	Stable	Complete
Sea Domain	Stable	Complete
Space Domain	Stable	Complete
XR Integration	Stable	Complete
Cloud Burst	Stable	Complete
Digital Thread	Stable	Complete
Machine Learning	Stable	Complete
GPU Compute	Stable	Complete
Sensors	Stable	Complete
DIS Protocol	Stable	Complete
HLA Protocol	Stable	Complete
Python Bindings	Stable	0.5.0
Lua Bindings	Stable	0.5.0

Test Coverage: 1150+ unit tests across all modules

What's New in v0.5.0¶

Phase 7 Complete¶

JaguarEngine v0.5.0 marks the completion of Phase 7, delivering enterprise-grade simulation capabilities:

GPU Acceleration - Multi-backend support: CUDA, OpenCL, Metal, Vulkan - Hybrid CPU-GPU physics pipeline with automatic load balancing - GPU-accelerated collision detection and particle systems

Extended Reality - Full OpenXR integration with VR/AR headset support - HRTF-based spatial audio with room acoustics and occlusion - Comprehensive haptic feedback: controllers, vests, motion platforms - G-force simulation for immersive flight training

Cloud Native - Auto-scaling cloud burst capability for 100,000+ entities - Spatial and domain-based partitioning strategies - Raft consensus with distributed time management - Entity migration with predictive trajectory analysis

Digital Thread - Complete lifecycle tracking with state snapshots - Physics-based degradation and failure prediction - Digital twin integration for predictive maintenance

Machine Learning - ONNX model inference with automatic optimization - Neural autopilot with multi-objective training - Gym-compatible reinforcement learning environment - Model repository with versioning and A/B testing

Community & Support¶

GitHub Issues: Report bugs and request features
Discussions: Ask questions and share ideas
Contributing: Development guidelines

License¶

See LICENSE for details.