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#

Queries#

Model Components#

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 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://github.com/open223/models.open223.info/raw/main/ontologies/223p.ttl")

# 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()], 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
@prefix ns2: <http://data.ashrae.org/standard223#> .
@prefix ns5: <http://data.ashrae.org/standard223/data/scb-vrf#> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

[] a sh:ValidationReport ;
    sh:conforms false ;
    sh:result [ a sh:ValidationResult ;
            sh:focusNode ns5:00632 ;
            sh:resultMessage "s223: A DomainSpace must be enclosed by a PhysicalSpace." ;
            sh:resultPath [ sh:inversePath ns2:encloses ] ;
            sh:resultSeverity sh:Info ;
            sh:sourceConstraintComponent sh:MinCountConstraintComponent ;
            sh:sourceShape <urn:well-known/1c1bef45> ],
        [ a sh:ValidationResult ;
            sh:focusNode ns5:00525 ;
            sh:resultMessage "s223: A DomainSpace must be enclosed by a PhysicalSpace." ;
            sh:resultPath [ sh:inversePath ns2:encloses ] ;
            sh:resultSeverity sh:Info ;
            sh:sourceConstraintComponent sh:MinCountConstraintComponent ;