Design Patterns

Design Patterns#

This file contains the Turtle code supporting the set of design patterns presented in the User Documentation site, in the section titled “Modeling Design Patterns”

Source#

The model was created using TopQuadrant TopBraid Composer Maestro Edition.

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#

Description	Query URL
Select all triples from model.	Query Link

Model Components#

Parent Class	Class	Instances
Equipment	Motor	6
Equipment	ElectricBreaker	5
Equipment	Luminaire	4
Equipment	OccupantMotionSensor	4
Equipment	Actuator	2
Equipment	Controller	1
Connection	ElectricWire	12
ConnectionPoint	InletConnectionPoint	21
ConnectionPoint	OutletConnectionPoint	19
DomainSpace		5
Property	QuantifiableProperty	6
Property	EnumeratedActuatableProperty	4
Property	EnumeratedObservableProperty	4
Property	EnumerableProperty	3

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.

Note

BuildingMOTIF installation To install the buildingmotif library, you can use the following command:

pip install 'buildingmotif[topquadrant] @ git+https://github.com/NREL/buildingmotif.git@develop'

If you do not have Java installed, you can use the following command to install the library:

pip install 'buildingmotif @ git+https://github.com/NREL/buildingmotif.git@develop'

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:design-patterns")
model.graph.parse("https://models.open223.info/design-patterns.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())

---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[1], line 1
----> 1 from buildingmotif import BuildingMOTIF
      2 from buildingmotif.dataclasses import Library, Model
      3 import logging

ModuleNotFoundError: No module named 'buildingmotif'