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 Building 4 Model 1

LBNL Example Building 4 Model 1

Example Building 4 is a real-world large-sized office building.

Example Building 4 Model 1 is provided by Lawrence Berkeley National Laboratory.

Schematic view

lbnl-example

Contents

This model contains a representation of the HVAC system.

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
Zone/room temperature sensorsQuery Link

Model Components

Parent ClassClassInstances
EquipmentSensor174
EquipmentActuator85
EquipmentDamper43
EquipmentValve42
EquipmentHeatingCoil41
EquipmentSingleDuctTerminal40
EquipmentFilter2
EquipmentFan2
EquipmentAirHandlingUnit1
EquipmentCoolingCoil1
ConnectionDuct132
ConnectionPipe42
ConnectionPointOutletConnectionPoint365
ConnectionPointInletConnectionPoint365
DomainSpace47
Zone47
PropertyQuantifiableObservableProperty437
PropertyQuantifiableActuatableProperty230
PropertyEnumeratedObservableProperty53
PropertyQuantifiableProperty6
PropertyEnumeratedActuatableProperty2

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:lbnl-bdg4-1")
model.graph.parse("https://models.open223.info/lbnl-bdg4-1.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 (1016):

--- Result 1 ---
Severity: sh:Violation
Focus Node: <http://data.ashrae.org/standard223/1.0/data/lbnl-example#vav-528-damper-command>
Message: s223: If the relation `hasAspect` is present, it shall associate the `Property` with an `EnumerationKind`.
Path: ns2:hasAspect
Value: ns2:EnumerationKind-Position
Source Constraint: sh:ClassConstraintComponent
Source Shape: <urn:well-known/be131f79>

--- Result 2 ---
Severity: sh:Violation
Focus Node: <http://data.ashrae.org/standard223/1.0/data/lbnl-example#MultipleZoneAhuOffice-ra-damper-command>
Message: s223: If the relation `hasAspect` is present, it shall associate the `Property` with an `EnumerationKind`.
Path: ns2:hasAspect
Value: ns2:EnumerationKind-Position
Source Constraint: sh:ClassConstraintComponent
Source Shape: <urn:well-known/be131f79>

--- Result 3 ---
Severity: sh:Violation
Focus Node: <http://data.ashrae.org/standard223/1.0/data/lbnl-example#MultipleZoneAhuOffice-
Fetching long content....