Input Nomenclature and Units
Naming Conventions
- API payloads use camelCase keys.
- Backend model attributes are snake_case.
- Percent-style losses are represented as fractions (
0.028 means 2.8%).
Unit Conventions
| Input family | Typical units |
|---|
Irradiance (ghi, dhi, dni, poa) | W/m2 |
Wind speed (windSpeed) | m/s |
Temperature (temperature) | C |
Angles (azimuth, axisTilt, tilt, maxAngle) | degrees |
Plant limits (poiLimitMW) | MWac |
Auxiliary thresholds (*kW) | kW |
Fractional losses (mismatch, dcohmic, etc.) | decimal fractions |
Reconciliation Status Labels
| Status | Meaning |
|---|
current | PDF term and current API field align directly |
legacy term | PDF term reflects older framing; current API has evolved shape or naming |
conflict | PDF wording conflicts with current validators/behavior |
Key Known Conflicts
| Topic | PDF wording | Current behavior |
|---|
/energymodels async semantics | Legacy docs text does not match current API default semantics | Sync is default; async queueing requires ?async=true |
layout.gcr range | 0.1 to 0.85 | Validator enforces 0.15 to 0.90 |
shading.transverseDiodes range | Wider mode-specific limits described | Validator enforces 0 to 10 |
Full Source-Reconciliation Matrix
- Rendered matrix page
- Generated matrix file:
packages/docs/energy-models/_generated/source-reconciliation.mdx
The reconciliation matrix is generated from energy_input_nomenclature_map.yaml and should be
updated whenever terminology or validation behavior changes.
