poka.sh

 Docs

OSC

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 Component.

At a glance
Original creator National Renewable Energy Laboratory (OpenStudio)
Purpose An OpenStudio component: one reusable model object, such as a construction, with the objects it depends on.
Extensions .osc
Poka parser poka-osc
Viewer poka-tree-viewer
Depth tier Parser with a shared viewer (see Depth tiers)
Breadth tier B4 Summary (see Breadth tiers)

How much Poka reads

B4 Summary. The container and metadata are read and summarised (counts, properties, structure), but the main content is not rendered.

Confidence: high (the reviewer read the code and a test that proves the claim). Basis: Reviewed 2026-10-16: parsers/poka-osc/src/lib.rs, tests/samples.rs and unit tests; corpus web-example.osc (OpenStudio 1.14.0) and web-example-2.osc (1.13.4), both from the OpenStudio resources/osversion folder. The ComponentData identity, timestamps, manifest-against-file check and the primary/dependency split are decoded; object contents are summarised.

What Poka does not read

  • The primary object's own fields (for example a construction's layer list) are not shown, only its name and class
  • Dependencies show at most three non-empty, non-reference field values each, with no field names; material properties such as conductivity or thickness are mostly cut off
  • Layer order and references between objects are not resolved into named layers
  • Only the first OS:ComponentData is read; components from newer OpenStudio versions (3.x) are untested

Background

An .osc uses the same object grammar as an OpenStudio model. What makes it a component is an OS:ComponentData object naming a stable UUID, a version UUID, timestamps and the objects it contains, the first of which is the component itself. Poka shows the primary object's name and class as the title and the rest as its dependencies (at most three field values each), with the component's identity and timestamps.

Versions

Version Identifier Poka Note
OpenStudio component OS:ComponentData Read

Libraries

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

  • roxmltree (used; MIT OR Apache-2.0; Rust)
  • OpenStudio SDK (candidate; licence unconfirmed; C++; https://github.com/NREL/OpenStudio) — SDK has a model::Component class (3.1.0 docs); .osc file layout not confirmed. LICENSE.md is BSD-style text but not named on the page. Bindings: Ruby, Python, C#.

Software that uses it

  • OpenStudio (NREL)

Sources