Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

LBNL Example SCB VRF

LBNL Example SCB VRF

This is a reference model provided by LBNL of a small office building using a VRF Heat Recovery System. Labels have been anonymized, and may not be interpretable.

Downloads

What are these files?
  • Turtle file (original): This is the original source Turtle file that was provided to models.open223.info, usually as the output of some model creation tool.

  • Turtle file (compiled): This is the original Turtle file with all inferred relationships and values added through SHACL inference against the 223P ontology and other dependencies. You should use this file for any further processing. It does not contain any of the ontologies.

  • Turtle file (with all imports): This is the compiled Turtle file with all imports included in the file (223P ontology, QUDT ontology, and others). This is helpful when you do not want to deal with downloading and managing ontology dependencies. It is also much larger than the compiled file.

  • JSON-LD file (original): This is the original Turtle file converted to the JSON-LD format.

Turtle is a syntax for RDF (Resource Description Framework) that is easy to read and write. It is a popular format for representing linked data. Parsers and serializers are available in many programming languages. JSON-LD is a JSON-based format for linked data that is easy to use with JavaScript and other web technologies.

Queries

DescriptionQuery URL
Select all triples from model.Query Link

Model Components

Parent ClassClassInstances
EquipmentFan16
EquipmentValve14
EquipmentCoil13
EquipmentFanPoweredTerminal13
EquipmentDamper3
EquipmentFilter2
EquipmentAirHandlingUnit1
EquipmentCompressor1
EquipmentHeatPump1
EquipmentHeatExchanger1
ConnectionPointOutletConnectionPoint192
ConnectionPointBidirectionalConnectionPoint110
ConnectionPointInletConnectionPoint96
ExternalReferenceBACnetExternalReference517
DomainSpace13
PropertyEnumerableProperty292
PropertyActuatableProperty275
PropertyObservableProperty273
PropertyQuantifiableProperty262
PropertyEnumeratedObservableProperty148
PropertyEnumeratedActuatableProperty144
PropertyQuantifiableActuatableProperty131
PropertyQuantifiableObservableProperty125

Load and Validate Model

This code uses the BuildingMOTIF library to load the 223P ontology and the model file into a temporary in-memory instance. It then validates the model against the ontology. If the model is invalid, it will print the validation report.

To run this code, you need to have Java installed on your system. If you do not have Java installed, you can remove the shacl_engine='topquadrant' parameter from the BuildingMOTIF constructor. Be warned that without the shacl_engine='topquadrant' parameter, the validation process will be slower.

from buildingmotif import BuildingMOTIF
from buildingmotif.dataclasses import Library, Model
import ontoenv
import logging

# Create a BuildingMOTIF object. If you do not have Java installed, remove the "shacl_engine" parameter
bm = BuildingMOTIF('sqlite://', shacl_engine='topquadrant', log_level=logging.ERROR)

# load 223P library. We will load a recent copy from the models.open223.info
# git repository; later, we will load this from the location of the actual standard
s223 = Library.load(ontology_graph="https://open223.info/223p.ttl", infer_templates=False, run_shacl_inference=False)
unit = Library.load(ontology_graph="http://qudt.org/3.1.1/vocab/unit", infer_templates=False, run_shacl_inference=False)
quantitykind = Library.load(ontology_graph="http://qudt.org/3.1.1/vocab/quantitykind", infer_templates=False, run_shacl_inference=False)

# load the model into the BuildingMOTIF instance
model = Model.create("urn:scb-vrf")
model.graph.parse("https://models.open223.info/scb-vrf.ttl")

# validate the model against 223P ontology
ctx = model.validate([s223.get_shape_collection(),
                      unit.get_shape_collection(),
                      quantitykind.get_shape_collection()],
                     error_on_missing_imports=False)

# print the validation result
print(f"Model is valid: {ctx.valid}")

# if the model is invalid, print the validation report
if not ctx.valid:
    print(ctx.report_string[:1000]) # first 1000 characters of the report

# BuildingMOTIF can also interpret the report to provide recommendations on fixes
for focus_node, diffs in ctx.get_reasons_with_severity("Violation").items():
    if len(diffs) == 0:
        continue
    print(focus_node)
    for diff in diffs:
        print("  - " + diff.reason())
Model is valid: 0
Validation Report
Conforms: False

Validation Results (1289):

--- Result 1 ---
Severity: sh:Info
Focus Node: ns3:01060
Message: s223: A `DomainSpace` must be enclosed by a `PhysicalSpace`.
Path: _:n6b0e42734d78472bb233457122451dfeb3
Source Constraint: sh:MinCountConstraintComponent
Source Shape: <urn:well-known/57ee7099>

--- Result 2 ---
Severity: sh:Info
Focus Node: ns3:00418
Message: s223: A `DomainSpace` must be enclosed by a `PhysicalSpace`.
Path: _:n6b0e42734d78472bb233457122451dfeb5
Source Constraint: sh:MinCountConstraintComponent
Source Shape: <urn:well-known/57ee7099>

--- Result 3 ---
Severity: sh:Info
Focus Node: ns3:00739
Message: s223: A `DomainSpace` must be enclosed by a `PhysicalSpace`.
Path: _:n6b0e42734d78472bb233457122451dfeb7
Source Constraint: sh:MinCountConstraintComponent
Source Shape: <urn:well-known/57ee7099>

--- Result 4 ---
Severity: sh:Info
Focus Node: ns3:00311
Message: s223: A `DomainSpace` must be enclosed by a `PhysicalSpace`.
Path: _:n6b0e42734d78472
Fetching long content....