Documentation portal

Documentation

The public interface for VEHRON is not just a repository checkout. It is a documented run flow: CLI entrypoints, YAML-defined studies, optional drive-cycle CSV inputs, extension slots, and packaged outputs intended to make engineering studies legible and reproducible.

Documentation index

Start from the task you are trying to complete

This page is a portal, not a placeholder. It points to the pages that explain installation, interface contracts, current scope, example studies, and citation requirements.

Getting Started

Installation, first run, standard drive-cycle example, and expected output artifacts.

Public Interface

Supported CLI contract, YAML contract, output contract, and local extension hooks.

Inputs & Outputs

Literal workflow from vehicle and testcase inputs to summary, timeseries, plots, and case package.

Models

Driver, dynamics, powertrain, battery, HVAC, thermal, auxiliaries, and charging behavior with maturity flags.

Validation & Limitations

What is verified in software, what is reproducible today, and what should not be overclaimed.

Citation / DOI

Version 0.1.0 citation text, DOI, release date, archive link, and BibTeX block.

Public interface summary

  • vehron run is the primary public run path
  • Vehicle YAML and testcase YAML define public studies
  • Optional drive-cycle CSV provides route speed trace input
  • Packaged case outputs are part of the supported workflow, not an afterthought
  • External battery and HVAC slots are supported extension points

Repository-backed facts surfaced on the site

  • Version 0.1.0
  • Python requirement >=3.10
  • License AGPL-3.0-only
  • DOI 10.5281/zenodo.19660006
  • Supported public path today centered on BEV studies

Compact reference

YAML structure and output artifact summary

Technical users usually want to know the shape of the interface before they install. These examples keep the website useful even before someone opens the repository in detail.

Input shape 
vehicle:
  archetype: bev_car_sedan
  powertrain: bev
testcase:
  drive_cycle_csv: wltp_class3b.csv
  ambient_c: 25
  payload_kg: 180
outputs:
  summary: true
  timeseries: true
  plots: true
Output package 
case/
  README.md
  summary.json
  timeseries.csv
  plots/
  inputs/
  resolved/