Merge origin/v1.5.0 into v1.5.0

Author: gtfierro

bricksrc/deprecations.py

@@ -1,6 +1,12 @@
-from .namespaces import BRICK, RDFS, SKOS, A, QUDTQK
+from .namespaces import BRICK, RDFS, SKOS, A, QUDTQK, REC
 
 deprecations = {
+    BRICK.Collection: {
+        "version": "1.5.0",
+        "mitigation_message": "Brick Collection is deprecated in favor of REC Collection to remove redundancy between the two ontologies.",
+        "replace_with": REC.Collection,
+        RDFS.subClassOf: BRICK.Entity,
+    },
     BRICK.Speed_Status: {
         "version": "1.4.0",
         "mitigation_message": "Speed Status is no longer necessary. Use Speed Mode Status for motors with various categorical speed settings, such as low, medium, and high. To further clarify, points representing the current speed of a variable speed fan as an analog value or input, use Speed Sensor.",

bricksrc/relationships.py

@@ -132,7 +132,7 @@
     "isTagOf": {
         A: [OWL.ObjectProperty, OWL.AsymmetricProperty, OWL.IrreflexiveProperty],
         "domain": BRICK.Tag,
-        "range": [BRICK.Entity, BRICK.Measurable],
+        "range": [BRICK.Entity, BRICK.Measurable, REC.Collection],
         RDFS.label: Literal("Is tag of", lang="en"),
     },
     "hasAssociatedTag": {
@@ -194,14 +194,24 @@
         OWL.inverseOf: BRICK.isMeteredBy,
         "domain": BRICK.Meter,
         # this is a special property that implements the 'range' as a SHACL shape
-        "range": [BRICK.Equipment, BRICK.Location, BRICK.Collection, REC.Architecture],
+        "range": [
+            BRICK.Equipment,
+            BRICK.Location,
+            REC.Collection,
+            REC.Architecture,
+        ],
         RDFS.label: Literal("meters", lang="en"),
     },
     "isMeteredBy": {
         A: [OWL.ObjectProperty, OWL.AsymmetricProperty, OWL.IrreflexiveProperty],
         OWL.inverseOf: BRICK.meters,
         # this is a special property that implements the 'domain' as a SHACL shape
-        "domain": [BRICK.Equipment, BRICK.Location, BRICK.Collection, REC.Architecture],
+        "domain": [
+            BRICK.Equipment,
+            BRICK.Location,
+            REC.Collection,
+            REC.Architecture,
+        ],
         "range": BRICK.Meter,
         RDFS.label: Literal("is metered by", lang="en"),
     },

bricksrc/root_class_shapes.ttl

@@ -16,7 +16,7 @@ brick:Location a sh:NodeShape ;
             [sh:not [ sh:class brick:Equipment ] ; sh:message "Location is an exclusive top class." ],
             [sh:not [ sh:class brick:Substance ] ; sh:message "Location is an exclusive top class." ],
             [sh:not [ sh:class brick:Quantity ] ; sh:message "Location is an exclusive top class." ],
-            [sh:not [ sh:class brick:Collection ] ; sh:message "Location is an exclusive top class." ] ;
+            [sh:not [ sh:class rec:Collection ] ; sh:message "Location is an exclusive top class." ] ;
     sh:property [
         sh:path brick:hasPart;
         sh:or ( [ sh:class brick:Location] [ sh:class rec:Space ] );
@@ -43,7 +43,7 @@ brick:Equipment a sh:NodeShape ;
     sh:not [ sh:class brick:Location ; sh:message "Instances of Equipment cannot be Locations." ] ,
            [ sh:class brick:Substance ; sh:message "Instances of Equipment cannot be Substances." ],
            [ sh:class brick:Quantity ; sh:message "Instances of Equipment cannot be Quantities." ],
-           [ sh:class brick:Collection ; sh:message "Instances of Equipment cannot be Collections." ],
+           [ sh:class rec:Collection ; sh:message "Instances of Equipment cannot be Collections." ],
            [ sh:class brick:Point ; sh:message "Instances of Equipment cannot be Points." ],
            [ sh:class brick:EntityProperty ; sh:message "Instances of Equipment cannot be EntityProperties." ] ;
     sh:property [
@@ -66,7 +66,7 @@ brick:Equipment a sh:NodeShape ;
         sh:or (
             [ sh:class brick:System ]
             [ sh:class brick:Equipment ]
-            [ sh:class brick:Collection ]
+            [ sh:class rec:Collection ]
         );
         sh:message "Equipment can be part of a Collection, System or other Equipment."
     ];
@@ -122,7 +122,7 @@ brick:Point a sh:NodeShape;
            [ sh:class brick:Location ; sh:message "Instances of Point cannot be Locations." ],
            [ sh:class brick:Substance ; sh:message "Instances of Point cannot be Substances." ],
            [ sh:class brick:Quantity ; sh:message "Instances of Point cannot be Quantities." ],
-           [ sh:class brick:Collection ; sh:message "Instances of Point cannot be Collections." ],
+           [ sh:class rec:Collection ; sh:message "Instances of Point cannot be Collections." ],
            [ sh:class brick:EntityProperty ; sh:message "Instances of Point cannot be EntityProperties." ] ;
     sh:property [
         sh:path brick:hasLocation ;
@@ -137,31 +137,6 @@ brick:Point a sh:NodeShape;
     ] ;
 .
 
-brick:Collection a sh:NodeShape;
-    sh:node [sh:not [ sh:class brick:Equipment ] ; sh:message "Collection is an exclusive top class." ],
-            [sh:not [ sh:class brick:Location ] ; sh:message "Collection is an exclusive top class." ],
-            [sh:not [ sh:class rec:Space ] ; sh:message "Collection is an exclusive top class." ],
-            [sh:not [ sh:class brick:Substance ] ; sh:message "Collection is an exclusive top class." ],
-            [sh:not [ sh:class brick:Quantity ] ; sh:message "Collection is an exclusive top class." ],
-            [sh:not [ sh:class brick:Point ] ; sh:message "Collection is an exclusive top class." ] ;
-    sh:property [
-        sh:path brick:hasPart;
-        sh:maxCount 0 ;
-        sh:message "Collections must use rec:includes instead of brick:hasPart."
-    ];
-    sh:property [
-        sh:path rec:includes;
-        sh:or (
-            [ sh:class brick:Equipment ]
-            [ sh:class brick:Location ]
-            [ sh:class rec:Space ]
-            [ sh:class brick:Point ]
-            [ sh:class brick:Collection ]
-        );
-        sh:message "A Collection can include Equipment, Locations/Spaces, Points, and other Collections."
-    ];
-    .
-
 bsh:hasHotColdDeck
     a sh:NodeShape ;
     sh:targetClass brick:DDAHU ;

bricksrc/rules.ttl

@@ -496,35 +496,6 @@ bsh:hasSubstance a sh:NodeShape ;
     sh:class brick:Substance ;
 .
 
-
-# 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.4/Brick> ;
-    ] ;
-.
-
 bsh:SystemLoopLegacyHasPartIncludes a sh:NodeShape ;
     sh:targetClass brick:System, brick:Loop ;
     sh:rule [

examples/connections/duct.ttl

@@ -5,7 +5,7 @@
 @prefix : <http://example.com/duct_example/> .
 
 <http://example.com/duct_example> a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.4/Brick>,
+    owl:imports <https://brickschema.org/schema/1.5/Brick>,
                 <https://brickschema.org/extension/s223extension> .
 
 :saf1  a  brick:Supply_Air_Flow_Sensor ;

examples/connections/rvav.ttl

@@ -6,7 +6,7 @@
 
 
 <http://example.com/rvav_example> a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.4/Brick>,
+    owl:imports <https://brickschema.org/schema/1.5/Brick>,
                 <https://brickschema.org/extension/s223extension> .
 
 # define the VAV with air and water connection points
@@ -75,4 +75,3 @@
     rdfs:label "Pipe 2" ;
     s223:hasMedium s223:Fluid-Water ;
     s223:cnx  :vav_water_outlet, :boiler_water_return .
-

extensions/brick_extension_interpret_223.shapes.ttl

@@ -2,7 +2,7 @@
 # imports: http://data.ashrae.org/standard223/1.0/model/all
 # imports: http://www.w3.org/ns/shacl#
 # imports: https://brickschema.org/extension/mappings_223
-# imports: https://brickschema.org/schema/1.4/Brick
+# imports: https://brickschema.org/schema/1.5/Brick
 # prefix: s223tobrick
 
 @prefix brick: <https://brickschema.org/schema/Brick#> .
@@ -254,7 +254,7 @@ $this s223:hasMeasurementLocation/s223:isConnectionPointOf/rdf:type ?class .
   owl:imports <http://data.ashrae.org/standard223/1.0/model/all> ;
   owl:imports sh: ;
   owl:imports <https://brickschema.org/extension/mappings_223> ;
-  owl:imports <https://brickschema.org/schema/1.4/Brick> ;
+  owl:imports <https://brickschema.org/schema/1.5/Brick> ;
   owl:versionInfo "Created with TopBraid Composer" ;
   sh:declare [
       sh:namespace "http://data.ashrae.org/standard223#"^^xsd:anyURI ;

extensions/brick_extension_s223_extension.shapes.ttl

@@ -2,7 +2,7 @@
 # imports: http://data.ashrae.org/standard223/1.0/model/all
 # imports: http://www.w3.org/ns/shacl#
 # imports: https://brickschema.org/extension/brick_extension_interpret_223
-# imports: https://brickschema.org/schema/1.4/Brick
+# imports: https://brickschema.org/schema/1.5/Brick
 # prefix: s223ext
 
 @prefix brick: <https://brickschema.org/schema/Brick#> .
@@ -25,7 +25,7 @@
   owl:imports <http://data.ashrae.org/standard223/1.0/model/all> ;
   owl:imports sh: ;
   owl:imports <https://brickschema.org/extension/brick_extension_interpret_223> ;
-  owl:imports <https://brickschema.org/schema/1.4/Brick> ;
+  owl:imports <https://brickschema.org/schema/1.5/Brick> ;
   owl:versionInfo "Created with TopBraid Composer" ;
       sh:declare [ sh:namespace "http://data.ashrae.org/standard223#"^^xsd:anyURI ;
             sh:prefix "s223" ],

generate_brick.py

@@ -710,7 +710,6 @@ def add_definitions(graph=G):
                 # add seeAlso only if provided
                 graph.add((term, RDFS.seeAlso, URIRef(definition[2])))
 
-
     qstr = """
     select ?param where {
       ?param rdfs:subClassOf* brick:Limit.
@@ -765,7 +764,7 @@ def add_definitions(graph=G):
             )
 
 
-def handle_deprecations(graph: Graph=G):
+def handle_deprecations(graph: Graph = G):
     for deprecated_term, md in deprecations.items():
         term_type = md.get(A)
         if term_type:
@@ -815,7 +814,9 @@ def handle_deprecations(graph: Graph=G):
     adds it to the graph. If available, adds the source information of
     through RDFS.seeAlso.
     """
-    with open(Path("./bricksrc/deprecated_definitions.csv"), encoding="utf-8") as dictionary_file:
+    with open(
+        Path("./bricksrc/deprecated_definitions.csv"), encoding="utf-8"
+    ) as dictionary_file:
         dictionary = csv.reader(dictionary_file)
 
         header = next(dictionary)
@@ -832,10 +833,9 @@ def handle_deprecations(graph: Graph=G):
             if len(definition) > 2 and definition[2]:
                 # add seeAlso only if provided
                 graph.add((term, RDFS.seeAlso, URIRef(definition[2])))
-                
 
 
-def handle_concept_labels(graph: Graph=G):
+def handle_concept_labels(graph: Graph = G):
     """
     Adds labels to all concepts in the Brick namespace, unless they already have one.
     Brick concepts are all subclasses of Brick.Entity and subproperties of Brick.Relationship.
@@ -896,7 +896,6 @@ def handle_concept_labels(graph: Graph=G):
     },
     "Point": {"tags": [TAG.Point]},
     "Measurable": {"tags": [TAG.Measurable]},
-    "Collection": {"tags": [TAG.Collection]},
 }
 define_classes(roots, BRICK.Class)  # <= Brick v1.3.0
 define_classes(roots, BRICK.Entity)  # >= Brick v1.3.0
@@ -936,7 +935,7 @@ def handle_concept_labels(graph: Graph=G):
 # define other root class structures
 define_classes(location_subclasses, BRICK.Location)
 define_classes(equipment_subclasses, BRICK.Equipment)
-define_classes(collection_classes, BRICK.Collection)
+define_classes(collection_classes, REC.Collection)
 define_classes(hvac_subclasses, BRICK.HVAC_Equipment)
 define_classes(hvac_valve_subclasses, BRICK.HVAC_Equipment)
 define_classes(valve_subclasses, BRICK.Equipment)

tests/conftest.py

@@ -3,7 +3,6 @@
 """
 import pytest
 from rdflib import Namespace
-import ontoenv
 from ontoenv import OntoEnv
 import brickschema
 import glob
@@ -32,6 +31,7 @@ def pytest_configure(config):
         "markers", "slow: mark tests as slow (deselect w/ '-m \"not slow\"')"
     )
 
+
 @pytest.fixture()
 def brick():
     g = brickschema.Graph()
@@ -43,6 +43,7 @@ def brick():
     g.remove((None, OWL.imports, None))
     return g
 
+
 @pytest.fixture()
 def brick_with_imports():
     env = OntoEnv(read_only=True)