poka.sh

 Docs

OSW

Generated by scripts/gen-format-pages.py from docs/data/format-metadata/, FILE_FORMATS.csv and docs/formats-master.csv. Do not edit by hand: change the source, then run the script.

OpenStudio Workflow.

At a glance
Original creator National Renewable Energy Laboratory (OpenStudio)
Purpose An OpenStudio workflow: a seed model, a weather file and an ordered list of measures (scripts that change the model), each with its arguments, as JSON.
Extensions .osw
Poka parser poka-osw
Viewer poka-tree-viewer
Depth tier Parser with a shared viewer (see Depth tiers)
Breadth tier B2 Broad (see Breadth tiers)

How much Poka reads

B2 Broad. The common content of the current and the common older versions is decoded. Some named features or versions are not, and are listed.

Confidence: high (the reviewer read the code and a test that proves the claim). Basis: Reviewed 2026-10-16: parsers/poka-osw/src/lib.rs, tests/samples.rs and unit tests; corpus web-full.osw, web-min.osw and web-workflow.osw (empty steps, basic ISO timestamps). The out.osw result branch is covered only by a fixture built from the documented schema; no real out.osw is in the corpus.

What Poka does not read

  • run_options (debug, fast, skip-zip and similar settings) are not read
  • Per-step results: initial and final condition, step_info, step_files, per-step start and finish times and logs are not shown; only result status, values, warnings and errors are
  • osa_checksum and osd_checksum are not shown
  • Caps of 500 steps, 60 arguments per step and 20 messages per step
  • Nested argument objects and arrays show only as [n items] or {n keys}
  • The out.osw branch has not been checked against a real run output

Background

The order of the steps is the meaning of the file: the same measures in another order make a different building. Poka shows the seed and weather files, the measure paths and the steps as a numbered sequence, never sorted, each with its arguments. The two timestamp forms found in the corpus (extended and basic ISO 8601) are both read.

Versions

Version Identifier Poka Note
OpenStudio workflow JSON Read

Libraries

Libraries Poka uses or has assessed for this format, with the status, licence and language the registry records.

Sources