Public interface

Public Interface & Extension Guide

Advanced users usually want to know the supported public interface before they decide whether a tool fits their workflow. This page summarizes the CLI contract, YAML contract, output contract, and local extension hooks.

CLI contract

  • Primary public entrypoint centered on vehron run
  • Inputs passed through vehicle and testcase configuration files
  • Packaged artifacts written as part of the standard run flow

YAML contract

  • Vehicle archetype YAML
  • Testcase YAML
  • Optional route / drive-cycle CSV reference
  • Environment, payload, and charging window fields

Output contract

  • summary.json
  • timeseries.csv
  • Plots
  • Copied input files, resolved configs, and case README

External model hooks

  • External battery models loaded from a local Python file
  • External HVAC models loaded from a local Python file
  • Slot and interface-based integration for private subsystem code

Why this matters

This is one of VEHRON’s strongest differentiators for battery teams, research groups, and companies that need private subsystem integration without publishing internal IP or rewriting the simulation engine.