Hermes
Simulation Orchestration Platform for Aerospace
Loading...
Searching...
No Matches
hermes.scripting.api Namespace Reference

Classes

class  SimulationAPI

Detailed Description

Python API for interacting with running simulations.

This module provides the SimulationAPI class for external scripts to
connect to and interact with running Hermes simulations via shared memory.

Example:
    from hermes.scripting import SimulationAPI

    with SimulationAPI("/hermes_sim") as sim:
        # Wait for simulation to start
        sim.wait_frame(10)

        # Inject a value
        sim.set("module.signal", 100.0)

        # Sample results
        value = sim.get("module.output")
        print(f"Output: {value}")

Determinism:
    Time is tracked internally as integer nanoseconds. Use `get_time_ns()`
    and `wait_time_ns()` for deterministic comparisons. The float-based
    `get_time()` and `wait_time()` methods are provided for convenience.