JSON Schemas

The following JSON Schema files describe the structure of each JSON input file in a Novomodelo case directory. Point your editor’s JSON Schema validation setting at the appropriate file to get autocompletion, hover documentation, and inline error highlighting while authoring case inputs.

For a complete description of each file’s fields and validation rules, see the Case Format reference page.

operational_start_date

Every system/* entity registry schema requires an operational_start_date field; Case Format — Shared entity fields states its format and its role in the canonical entity order.

Available schemas

Schema file	Input file	Description
config.schema.json	config.json	Study configuration: training parameters, stopping rules, cut selection, per-phase solver profiles, backward-scheduler parallelism, simulation settings, and export flags
penalties.schema.json	penalties.json	Global penalty cost defaults for bus deficit, line exchange, hydro violations, and non-controllable source curtailment
stages.schema.json	stages.json	Temporal structure of the study: stage sequence, load blocks, and policy graph horizon
buses.schema.json	system/buses.json	Electrical bus registry: bus identifiers, names, and optional entity-level deficit cost tiers
lines.schema.json	system/lines.json	Transmission line registry: line identifiers, source/target buses, and directional MW capacity bounds
hydros.schema.json	system/hydros.json	Hydro plant registry: reservoir bounds, outflow limits, generation model parameters, and cascade linkage
thermals.schema.json	system/thermals.json	Thermal plant registry: generation bounds and linear cost coefficients
energy_contracts.schema.json	system/energy_contracts.json	Bilateral energy contract registry (optional entities)
non_controllable_sources.schema.json	system/non_controllable_sources.json	Intermittent (non-dispatchable) generation source registry (optional entities)
pumping_stations.schema.json	system/pumping_stations.json	Pumping station registry (optional entities)
production_models.schema.json	system/hydro_production_models.json	Production model selection, FPHA hyperplane config, and per-stage productivity overrides (optional)
generic_parameters.schema.json	constraints/generic_parameters.json	Named study parameters — constant, per-stage, seasonal, computed, or per-(stage,block) values referenced by name from generic constraints
initial_conditions.schema.json	initial_conditions.json	Initial reservoir storage and filling storage, recent inflow observations for PAR-lag initialization, past defluences (travel-time seed), and past anticipated commitments
correlation.schema.json	scenarios/correlation.json	Inter-site correlation matrix for scenario generation (supports inflow, load, and NCS entity types)
generic_constraints.schema.json	constraints/generic_constraints.json	User-defined linear constraints authored via named expressions and interval bounds over LP variables, with optional slack penalties
load_factors.schema.json	scenarios/load_factors.json	Block-level load scaling factors for bus-stage demand profiles
non_controllable_factors.schema.json	scenarios/non_controllable_factors.json	Block-level NCS availability scaling factors per source per stage per block
post_study_stages.schema.json	post_study_stages.json	Post-study boundary stages plus per-(thermal, post-study-stage) cost and min/max generation bounds

Using schemas in your editor

Every schema is served from this site at a stable URL, /schemas/<name>.schema.json (for example https://docs.novomodelo.invalid/schemas/config.schema.json), which serves the schemas of the novomodelo release the latest documentation describes. Each frozen documentation version in the header’s version picker serves the schemas of its own novomodelo release under its path, /vX.Y/schemas/<name>.schema.json. Point your editor’s JSON Schema mapping at the URL that matches the novomodelo release you run, for autocompletion and validation while authoring case inputs.

VS Code

Add a json.schemas entry to your workspace .vscode/settings.json:

{
  "json.schemas": [
    {
      "fileMatch": ["config.json"],
      "url": "https://docs.novomodelo.invalid/schemas/config.schema.json"
    },
    {
      "fileMatch": ["system/hydros.json"],
      "url": "https://docs.novomodelo.invalid/schemas/hydros.schema.json"
    }
  ]
}

Alternatively, add a $schema key directly inside each JSON file:

{
  "$schema": "https://docs.novomodelo.invalid/schemas/config.schema.json",
  "training": {
    "selection": { "method": "sampled", "forward_passes": 192 },
    "stopping_rules": [{ "type": "iteration_limit", "limit": 200 }]
  }
}

Neovim (via jsonls)

Configure json.schemas in your nvim-lspconfig setup for jsonls following the same URL pattern shown above.

JetBrains IDEs

Go to Preferences > Languages & Frameworks > Schemas and DTDs > JSON Schema Mappings, add a new mapping, paste the schema URL, and select the file pattern.

Provenance and refreshing

These schemas are generated in the novomodelo repository from the novomodelo-io Rust types — the Rust types are the ground truth, and the schema files are their generated output, licensed Apache-2.0. This site vendors the copy generated at novomodelo v0.18.0 under public/schemas/ so the files have a stable URL to serve from and to link to.

Do not hand-edit any vendored schema file. When novomodelo regenerates the schemas (after a change to a novomodelo-io input type), re-vendor the committed copy here with (the command reads the v0.18.0 tag by default; -- --ref <tag> selects another):

npm run refresh:schemas

Run npm run refresh:schemas -- --check to verify the committed copy still matches the source tag without writing anything.