Add additional ontology imports (#501)

* fix/compare_versions_tool

* add ref schema and REC imports

* add brickpatches

* fixing up location haspart constraints

* updating REC

* bump deps

* working on rec/brick

* fixing prefixes and rules

* bump ontoenv

* initialie quantities

* Merging quantities

* fixing use of ontoenv

* fix ontoenv usage for tests

* more rec changes

---------

Co-authored-by: Filip Henrik Larsen <[email protected]>

Author: gtfierro

bricksrc/location.py

@@ -628,8 +628,10 @@
         },
         "constraints": {
             BRICK.hasPart: [
-                BRICK.Room,
                 BRICK.Space,
+                BRICK.Wing,
+                BRICK.Outdoor_Area,
+                BRICK.Floor,
             ],
         },
     },

bricksrc/namespaces.py

@@ -15,6 +15,7 @@
 SOSA = Namespace("http://www.w3.org/ns/sosa/")
 VCARD = Namespace("http://www.w3.org/2006/vcard/ns#")
 S223 = Namespace("http://data.ashrae.org/standard223#")
+REC = Namespace("https://w3id.org/rec#")
 
 # QUDT namespaces
 QUDT = Namespace("http://qudt.org/schema/qudt/")
@@ -52,3 +53,4 @@ def bind_prefixes(g):
     g.bind("bacnet", BACNET)
     g.bind("ifc", IFC)
     g.bind("s223", S223)
+    g.bind("rec", REC)

bricksrc/ontology.py

@@ -2,7 +2,7 @@
 from rdflib import Literal, BNode, URIRef
 from rdflib.collection import Collection
 
-from .namespaces import DCTERMS, SDO, RDFS, RDF, OWL, BRICK, SH, XSD, REF
+from .namespaces import DCTERMS, SDO, RDFS, RDF, OWL, BRICK, SH, XSD, REF, REC
 from .version import BRICK_VERSION, BRICK_FULL_VERSION
 
 # defines metadata about the Brick ontology
@@ -38,11 +38,14 @@
     "qudtoverlay": "http://qudt.org/2.1/schema/shacl/overlay/qudt",
     "unit": "http://qudt.org/2.1/vocab/unit",
     "bacnet": "http://data.ashrae.org/bacnet/2020",
+    "ref": "https://brickschema.org/schema/Brick/ref",
+    "rec": "https://w3id.org/rec",
+    "recimports": "https://w3id.org/rec/recimports",
+    "brickpatches": "https://w3id.org/rec/brickpatches",
     "quantitykind": "http://qudt.org/2.1/vocab/quantitykind",
     "qudtsou": "http://qudt.org/2.1/vocab/sou",
     "qudtdv": "http://qudt.org/2.1/vocab/dimensionvector",
     "qudtprefix": "http://qudt.org/2.1/vocab/prefix",
-    "ref": "https://brickschema.org/schema/Brick/ref",
 }
 
 shacl_namespace_declarations = [
@@ -76,6 +79,10 @@
         SH.namespace: Literal(str(REF), datatype=XSD.anyURI),
         SH.prefix: Literal("ref"),
     },
+    {
+        SH.namespace: Literal("https://w3id.org/rec#", datatype=XSD.anyURI),
+        SH.prefix: Literal("rec"),
+    },
 ]
 
 BRICK_IRI_VERSION = URIRef(f"https://brickschema.org/schema/{BRICK_VERSION}/Brick")

bricksrc/quantities.py

@@ -1,14 +1,17 @@
 from brickschema.graph import Graph
+from ontoenv import OntoEnv
 from rdflib import Literal, URIRef
 from .namespaces import SKOS, OWL, RDFS, BRICK, QUDTQK, QUDTDV, QUDT, UNIT
 
-
+env = OntoEnv(initialize=True, search_dirs=["support/"])
 g = Graph()
 g.load_file("support/VOCAB_QUDT-QUANTITY-KINDS-ALL-v2.1.ttl")
 g.load_file("support/VOCAB_QUDT-UNITS-ALL-v2.1.ttl")
 g.bind("qudt", QUDT)
 g.bind("qudtqk", QUDTQK)
-g.expand(profile="shacl", backend="topquadrant")
+
+env.import_dependencies(g)
+g.expand("shacl", backend="topquadrant")
 
 
 def get_units(qudt_quantity):

bricksrc/rules.ttl

@@ -444,6 +444,34 @@ bsh:hasSubstance a sh:NodeShape ;
 .
 
 
+# rule to add rec:includes when a brick:Collection contains a brick:Equipment
+bsh:CollectionIncludesEquipment a sh:NodeShape ;
+    sh:targetClass brick:Collection, brick:System, brick:Equipment ;
+    sh:rule [
+        a sh:SPARQLRule ;
+        sh:construct """
+        CONSTRUCT {
+            $this rec:includes ?eq .
+        }
+        WHERE {
+            $this brick:hasPart ?eq .
+            {
+                ?eq rdf:type/rdfs:subClassOf* brick:Equipment .
+            }
+            UNION
+            {
+                ?eq rdf:type/rdfs:subClassOf* brick:Collection .
+            }
+            UNION
+            {
+                ?eq rdf:type/rdfs:subClassOf* brick:System .
+            }
+        }
+        """ ;
+        sh:prefixes <https://brickschema.org/schema/1.3/Brick> ;
+    ] ;
+.
+
 # add unidirectional charging to all EVsE chargers as a default value
 # UNLESS there is already a brick:electricVehicleChargerDirectionality attribute
 # on ports associated with the charger

examples/last_known_value/last_known_value.ttl

@@ -4,6 +4,7 @@
 @prefix unit: <http://qudt.org/vocab/unit/> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 @prefix bacnet: <http://data.ashrae.org/bacnet/2020#> .
+@prefix rec: <https://w3id.org/rec#> .
 @prefix owl: <http://www.w3.org/2002/07/owl#> .
 
 bldg: a  owl:Ontology ;
@@ -20,8 +21,9 @@ bldg:sensor1 a brick:Air_Temperature_Sensor ;
         bacnet:object-name "BLDG-Z410-ZATS" ;
         bacnet:objectOf bldg:sample-device ;
     ] ;
-    brick:lastKnownValue [
-        brick:value "72.0"^^xsd:float ;
+    brick:lastKnownValue bldg:sensor1_reading1 .
+
+bldg:sensor1_reading1  a rec:TemperatureObservation ;
+        brick:value "72.0"^^xsd:double ;
         brick:timestamp "2020-01-01T00:00:00Z"^^xsd:dateTime ;
-    ] ;
-.
+        rec:sourcePoint bldg:sensor1 .

examples/solar_array/solar_array.ttl

@@ -2,6 +2,10 @@
 @prefix brick: <https://brickschema.org/schema/Brick#> .
 @prefix unit: <http://qudt.org/vocab/unit/> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+
+<urn:example> a owl:Ontology ;
+    owl:imports <https://brickschema.org/schema/1.3/Brick> .
 
 # shared efficiency rating
 site:panel_efficiency  a brick:EfficiencyShape ;

generate_brick.py

@@ -1089,7 +1089,7 @@ def handle_deprecations():
 
 # create new directory for storing imports
 os.makedirs("imports", exist_ok=True)
-env = ontoenv.OntoEnv(initialize=True)
+env = ontoenv.OntoEnv(initialize=True, search_dirs=["support/"])
 for name, uri in ontology_imports.items():
     depg, loc = env.resolve_uri(str(uri))
     depg.serialize(Path("imports") / f"{name}.ttl", format="ttl")
@@ -1100,3 +1100,9 @@ def handle_deprecations():
 if not valid:
     print(report)
     sys.exit(1)
+
+# validate Brick
+# valid, _, report = pyshacl.validate(data_graph=G, advanced=True, allow_warnings=True)
+# if not valid:
+#    print(report)
+#    sys.exit(1)

support/SCHEMA_QUDT_NoOWL-v2.1.ttl

@@ -1761,7 +1761,7 @@ qudt:QuantityType-value
 qudt:QuantityValue
   a rdfs:Class ;
   a sh:NodeShape ;
-  rdfs:comment "A <i>Quantity Value</i> expresses the magnitude and kind of a quantity and is given by the product of a numerical value <code>n</code> and a unit of measure <code>U</code>. The number multiplying the unit is referred to as the numerical value of the quantity expressed in that unit. Refer to <a href=\"http://physics.nist.gov/Pubs/SP811/sec07.html\">NIST SP 811 section 7</a> for more on quantity values."^^rdf:HTML ;
+  rdfs:comment ""^^rdf:HTML ;
   rdfs:isDefinedBy <http://qudt.org/2.1/schema/shacl/qudt> ;
   rdfs:label "Quantity value" ;
   rdfs:subClassOf qudt:Concept ;