First run

Getting Started

This page is intended to be copy-paste ready. It covers installation, a first baseline run, a standard drive-cycle example, and the outputs you should expect from a successful VEHRON study.

Install 
python3 -m venv .venv
source .venv/bin/activate
pip install .
vehron --help
First run 
vehron run \
  --vehicle src/vehron/archetypes/bev_car_sedan.yaml \
  --testcase src/vehron/testcases/flat_highway_100kmh.yaml
Standard drive cycle 
vehron run \
  --vehicle src/vehron/archetypes/bev_car_sedan.yaml \
  --testcase src/vehron/testcases/wltp_class3b_standard.yaml
Produced outputs
  • summary.json
  • timeseries.csv
  • Plots
  • Copied inputs and resolved configs
  • Case README.md

Reference archetype files visible in the repository

  • bev_car_sedan.yaml
  • bev_bus_city.yaml
  • bev_three_wheeler.yaml
  • bev_truck_heavy.yaml
  • bev_two_wheeler.yaml

Important scope note

Files visible in the repository are not automatically equal to broad public support. The website should distinguish between artifacts present in the repo and the more narrowly documented supported public paths today.

What gets written to the case package

case/
  README.md
  summary.json
  timeseries.csv
  plots/
  inputs/
  resolved/

After the first run

  • Inspect summary metrics and time series for plausibility
  • Compare a baseline case with a standard cycle such as WLTP Class 3b
  • Review copied inputs and resolved configs for reproducibility
  • Move on to examples, models, validation, or external integration docs