Skip to content

README.md

Latest commit

 

History

History
60 lines (46 loc) · 1.41 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.41 KB
Raw

Python client for macro_traffic_sim gRPC Server

Python 3.10+ Typing: Typed

Python client library for the macroscopic traffic simulation gRPC server with full type hints support.

Installation

pip install macro-traffic-sim

Usage

import grpc
from macro_traffic_sim import (
    MacroServiceStub,
    NewSessionRequest,
    Node,
    Link,
    Zone,
    NetworkChunk,
    ZoneChunk,
    ModelConfigRequest,
    BprConfig,
    RunPipelineRequest,
    LinkVolumesRequest,
    UUIDv4,
)

# Connect to server
channel = grpc.insecure_channel("127.0.0.1:50052")
client = MacroServiceStub(channel)

# Create a new session
response = client.NewSession(NewSessionRequest())
session_id = response.session_id.value
print(f"Session: {session_id}")

# Push network, zones, configure, run pipeline, get results...

Documentation

  • Full example: See examples/ for a complete simulation workflow

Running the example

  1. Start the gRPC server:
cargo run --features server --bin macro_traffic_sim
  1. Run the example (from repository root):
source clients/python/.venv/bin/activate
python clients/python/examples/main.py