Schema Reference

Reference docs for the hand-written JSON Schema types in this repo, generated from the bundled OpenAPI specs.

Six packages, in dependency order:

  1. Shared basics — Domain-neutral shared types: the unit convention, the function-data family, and the value shapes and supplemental attributes that carry no power semantics. Consumed by the data layer and the time series store, neither of which should inherit power-specific definitions.
  2. Time series — Time series associations: the six canonical time series types defined by the upstream data layer and their metadata, without the dense values
  3. Costs and curves — Shared types for the Sienna power systems ecosystem: curves, enums, helpers (MinMax, UpDown, CostCurve, etc.)
  4. Grid topology and equipment — Power system operations models: Branch, StaticInjection, and Service components
  5. Investment planning — Power system investments models: Technologies, Financials, Requirements, SupplementalAttributes, and Portfolio components
  6. Machine dynamics — Power system dynamics models: DynamicGeneratorComponent and DynamicInverterComponent

Layering rule: the shared basics group carries no power semantics — every other package builds on it, directly or indirectly.

This site uses Just the Docs, a documentation theme for Jekyll.