GitHub

Document metadata

Every case may carry a top-level meta object providing provenance, licensing, and versioning. It is optional for backward compatibility, but conformant writers should populate it. This is a data-model page — meta carries no OPF variables or constraints. Symbols are defined in Notation.

The meta object

FieldTypeDescription
$schemastring (URI)URI of the JSON Schema this file was validated against
versionstringVersion of this dataset (not the schema)
titlestringHuman-readable dataset name (distinct from the machine-readable root name)
descriptionstringFree-text notes or caveats
createdstring (ISO 8601)Creation timestamp, UTC
modifiedstring (ISO 8601)Last-revision timestamp, UTC
licensestringSPDX identifier (e.g. CC-BY-4.0) or an https:// URI to the licence
frequencynumber (Hz)Nominal system frequency — check-only (validated against line_geometry/linecode derivation frequency; never rescales)
authorsobject[]Ordered authors — see below
data_sourcesobject[]Upstream data references — see below
case_study_generatorobjectTool that wrote the file — see below
provenanceobjectFree-form conversion/audit notes written by tooling

authors[]: name, email, orcid (bare hyphenated form XXXX-XXXX-XXXX-XXXX, without the https://orcid.org/ prefix).

data_sources[]: name, url (dereferenceable https://), format (e.g. OpenDSS, PMD-JSON, MATPOWER), doi, version.

case_study_generator: tool, version.

Conformance notes

  • $schema follows the JSON Schema $schema keyword convention; it should be a versioned, dereferenceable URI (a floating reference to main is acceptable in draft).
  • Dates must be UTC and should include a time component (THH:MM:SSZ); a date-only value is permitted when the time is unknown.
  • license should be a URI when the licence needs specific attribution language beyond an SPDX identifier.
  • Unknown fields may be present; conformant readers must ignore them.
  • frequency is a consistency check only — it never defaults or rescales any quantity.

Example

{
  "name": "enwl_network1_feeder1",
  "meta": {
    "$schema": "https://example.org/bmopf/schema/v1/bmopf.json",
    "version": "1.0",
    "title": "ENWL LV Network 1, Feeder 1",
    "description": "Four-wire 230/400 V LV feeder from the ENWL LVNS dataset.",
    "created": "2026-06-15T10:00:00Z",
    "license": "https://creativecommons.org/licenses/by/4.0/",
    "frequency": 50.0,
    "authors": [
      { "name": "A. Researcher", "email": "a@example.org", "orcid": "0000-0001-9534-2265" }
    ],
    "data_sources": [
      { "name": "ENWL LVNS dataset", "url": "https://www.enwl.co.uk/lvns", "format": "OpenDSS" }
    ],
    "case_study_generator": { "tool": "BMOPFTools.jl", "version": "0.1.0" }
  },
  "bus": { "...": {} },
  "line": { "...": {} }
}