L200 up to 6.2.1.6

.pre-commit-config.yaml

@@ -39,3 +39,10 @@ repos:
     hooks:
       - id: flake8
         args: ['--ignore=E501,E402,W503,W504,E731,F401']
+  - repo: local
+    hooks:
+    -   id: format-xml
+        name: format xml and sch files
+        language: system
+        entry: python buildingsch.py clean
+        files: ^.*.(xml|sch)$

buildingsch.py

@@ -5,6 +5,7 @@
 
 from tools.validate_sch import validate_schematron, print_failure
 from tools.generate_sch import generate_sch
+from tools.clean_xml import clean_files
 
 
 def validate_schematrons(args):
@@ -58,6 +59,35 @@ def generate_all_schematron(args):
     sys.exit(0)
 
 
+def _clean_files(args):
+    for filename in args.filenames:
+        clean_files(filename)
+
+
+def clean_all_files(args):
+    """
+    Cleans all *.sch and *.xml files in the schematron directory.  Cleaning consists of:
+    - Removing blank lines
+    - Two space indentation
+    - Serializing with doctype = '<?xml version="1.0" encoding="UTF-8"?>
+    """
+    base_dir = 'schematron/'
+    updated_files = []
+    for root, _, files in os.walk(base_dir):
+        for name in files:
+            if not name.endswith('.xml') and not name.endswith('.sch'):
+                continue
+            filename = os.path.join(root, name)
+            updated = clean_files(filename)
+            if updated:
+                updated_files.append(filename)
+
+    for file_ in updated_files:
+        print(file_)
+
+    sys.exit(0)
+
+
 # Construct Parsers
 parser = argparse.ArgumentParser(description='Tool for validating and generating Schematron documents')
 subparsers = parser.add_subparsers()
@@ -145,6 +175,21 @@ def generate_all_schematron(args):
 )
 parser_generate.set_defaults(func=generate_all_schematron)
 
+# Clean command
+parser_clean_files = subparsers.add_parser('clean', description='Command for formatting one ore more *.xml or *.sch files')
+parser_clean_files.add_argument(
+    'filenames',
+    metavar='filenames',
+    type=str,
+    help='File(s) to clean',
+    nargs='+'
+)
+parser_clean_files.set_defaults(func=_clean_files)
+
+# Clean all command
+parser_clean_all_files = subparsers.add_parser('clean_all', description='Command for formatting all *.xml and *.sch files')
+parser_clean_all_files.set_defaults(func=clean_all_files)
+
 # command with no sub-commands should just print help
 parser.set_defaults(func=lambda _: parser.print_help())
 

schematron/lib/buildingElements.sch

@@ -60,7 +60,7 @@
       <assert test="auc:Address/auc:StreetAddressDetail/auc:Simplified/auc:StreetAddress" role="ERROR">element 'auc:StreetAddress' within element 'auc:Address/auc:StreetAddressDetail/auc:Simplified' is REQUIRED EXACTLY ONCE for: '<name/>'</assert>
     </rule>
   </pattern>
-<!--  Check for Lat and Long at the building level-->
+  <!--  Check for Lat and Long at the building level-->
   <pattern id="be.latLong">
     <rule context="auc:Buildings/auc:Building">
       <assert test="auc:Latitude" role="ERROR">element 'auc:Latitude' within element 'auc:Address' is REQUIRED EXACTLY ONCE for: '<name/>'</assert>

schematron/lib/contactElements.sch

@@ -26,9 +26,12 @@
       <let name="numContacts" value="count(auc:Contact)"/>
       <let name="numAuditors" value="count(auc:Contact/auc:ContactRoles/auc:ContactRole[text()='Energy Auditor'])"/>
       <let name="numOwners" value="count(auc:Contact/auc:ContactRoles/auc:ContactRole[text()='Owner'])"/>
-      <assert test="$numContacts &gt;= 2" role="ERROR">element 'auc:Contact' is REQUIRED AT LEAST TWICE for: '<name/>’. Current number of occurrences: <value-of select="$numContacts"/></assert>
-      <assert test="$numAuditors &gt;= 1" role="ERROR">element 'auc:Contact' with child element 'auc:ContactRoles/auc:ContactRole' with value 'Energy Auditor' is REQUIRED AT LEAST ONCE for: '<name/>’. Current number of occurrences: <value-of select="$numAuditors"/></assert>
-      <assert test="$numOwners &gt;= 1" role="ERROR">element 'auc:Contact' with child element 'auc:ContactRoles/auc:ContactRole' with value 'Owner' is REQUIRED AT LEAST ONCE for: '<name/>’. Current number of occurrences: <value-of select="$numOwners"/></assert>
+      <assert test="$numContacts &gt;= 2" role="ERROR">element 'auc:Contact' is REQUIRED AT LEAST TWICE for: '<name/>&#8217;. Current number of occurrences: <value-of select="$numContacts"/>
+      </assert>
+      <assert test="$numAuditors &gt;= 1" role="ERROR">element 'auc:Contact' with child element 'auc:ContactRoles/auc:ContactRole' with value 'Energy Auditor' is REQUIRED AT LEAST ONCE for: '<name/>&#8217;. Current number of occurrences: <value-of select="$numAuditors"/>
+      </assert>
+      <assert test="$numOwners &gt;= 1" role="ERROR">element 'auc:Contact' with child element 'auc:ContactRoles/auc:ContactRole' with value 'Owner' is REQUIRED AT LEAST ONCE for: '<name/>&#8217;. Current number of occurrences: <value-of select="$numOwners"/>
+      </assert>
     </rule>
   </pattern>
   <!--

schematron/lib/floorElements.sch

@@ -79,7 +79,8 @@
 -->
   <pattern abstract="true" id="fa.oneOfType">
     <rule context="$parent">
-      <assert test="count(auc:FloorArea[auc:FloorAreaType = $floorAreaType]) = 1" role="ERROR">element 'auc:FloorAreaType' with value '<value-of select="$floorAreaType"/>' is REQUIRED EXACTLY ONCE within element 'auc:FloorArea' for '<name/>'.  Currently occurs: <value-of select="count(auc:FloorArea[auc:FloorAreaType = $floorAreaType])"/></assert>
+      <assert test="count(auc:FloorArea[auc:FloorAreaType = $floorAreaType]) = 1" role="ERROR">element 'auc:FloorAreaType' with value '<value-of select="$floorAreaType"/>' is REQUIRED EXACTLY ONCE within element 'auc:FloorArea' for '<name/>'.  Currently occurs: <value-of select="count(auc:FloorArea[auc:FloorAreaType = $floorAreaType])"/>
+      </assert>
     </rule>
   </pattern>
   <!--
@@ -130,13 +131,20 @@
       <let name="unconditionedArea" value="number(concat(substring($unconditionedAreaValueComputed, 1, $endTextPosition1UCA),                                                          substring($unconditionedAreaValue, 1, $endTextPosition2UCA)))"/>
       <assert test="$conditionedArea &gt;= $cooledOnlyArea + $heatedOnlyArea + $heatedCooledArea + $ventilatedArea" role="ERROR">Conditioned Floor Area (<value-of select="$conditionedArea"/>) must be greater than or equal to: Heated and Cooled (<value-of select="$heatedCooledArea"/>) + Heated only (<value-of select="$heatedOnlyArea"/>) + Cooled only (<value-of select="$cooledOnlyArea"/>) + Ventilated (<value-of select="$ventilatedArea"/>)</assert>
       <assert test="$grossArea &gt;= $conditionedArea + $unconditionedArea and $unconditionedArea &gt;= 0" role="ERROR">Gross Floor Area (<value-of select="$grossArea"/>) must be greater than or equal to: Conditioned (<value-of select="$conditionedArea"/>) + Unconditioned (<value-of select="$unconditionedArea"/>) AND Unconditioned Floor Area must be &gt; 0</assert>
-      <assert test="false()" role="INFO">'Gross' Floor Area: <value-of select="$grossArea"/></assert>
-      <assert test="false()" role="INFO">'Cooled only' Floor Area: <value-of select="$cooledOnlyArea"/></assert>
-      <assert test="false()" role="INFO">'Heated only' Floor Area: <value-of select="$heatedOnlyArea"/></assert>
-      <assert test="false()" role="INFO">'Heated and Cooled' Floor Area: <value-of select="$heatedCooledArea"/></assert>
-      <assert test="false()" role="INFO">'Ventilated' Floor Area: <value-of select="$ventilatedArea"/></assert>
-      <assert test="false()" role="INFO">'Conditioned' Floor Area: <value-of select="$conditionedArea"/></assert>
-      <assert test="false()" role="INFO">'Unconditioned' Floor Area: <value-of select="$unconditionedArea"/></assert>
+      <assert test="false()" role="INFO">'Gross' Floor Area: <value-of select="$grossArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Cooled only' Floor Area: <value-of select="$cooledOnlyArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Heated only' Floor Area: <value-of select="$heatedOnlyArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Heated and Cooled' Floor Area: <value-of select="$heatedCooledArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Ventilated' Floor Area: <value-of select="$ventilatedArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Conditioned' Floor Area: <value-of select="$conditionedArea"/>
+      </assert>
+      <assert test="false()" role="INFO">'Unconditioned' Floor Area: <value-of select="$unconditionedArea"/>
+      </assert>
     </rule>
   </pattern>
   <!--
@@ -175,8 +183,10 @@
       <let name="buildingGrossArea" value="number(auc:FloorAreas/auc:FloorArea[auc:FloorAreaType='Gross']/auc:FloorAreaValue)"/>
       <let name="allSpaceFunctionSectionsGrossArea" value="number(sum(//auc:Section[auc:SectionType/text()='Space function']/auc:FloorAreas/auc:FloorArea[auc:FloorAreaType='Gross']/auc:FloorAreaValue))"/>
       <assert test="$buildingGrossArea &gt;= $allSpaceFunctionSectionsGrossArea" role="ERROR">auc:Building Gross Floor (<value-of select="$buildingGrossArea"/>) Area MUST BE GREATER THAN OR EQUAL TO the sum of all Gross Floor areas from elements auc:Section[auc:SectionType='Space function'] (<value-of select="$allSpaceFunctionSectionsGrossArea"/>)</assert>
-      <assert test="false()" role="INFO">Building Gross Floor Area: <value-of select="$buildingGrossArea"/></assert>
-      <assert test="false()" role="INFO">Sum of all auc:Section[auc:SectionType='Space function'] Gross Floor Area: <value-of select="$allSpaceFunctionSectionsGrossArea"/></assert>
+      <assert test="false()" role="INFO">Building Gross Floor Area: <value-of select="$buildingGrossArea"/>
+      </assert>
+      <assert test="false()" role="INFO">Sum of all auc:Section[auc:SectionType='Space function'] Gross Floor Area: <value-of select="$allSpaceFunctionSectionsGrossArea"/>
+      </assert>
     </rule>
   </pattern>
   <!--  Check that either a auc:FloorAreaValue or auc:FloorAreaPercentage is specifed, but not both

schematron/lib/id.sch

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <schema xmlns="http://purl.oclc.org/dsdl/schematron">
   <ns prefix="auc" uri="http://buildingsync.net/schemas/bedes-auc/2019"/>
-<!-- Require every element of the following type to have and ID:
+  <!-- Require every element of the following type to have and ID:
     Premises:
      - Facility - T
      - Site - T
@@ -47,7 +47,7 @@
      - Tenant
 
 -->
-<!--  Premises -->
+  <!--  Premises -->
   <!--
   Facility has ID
   <severity> error
@@ -92,7 +92,7 @@
       </assert>
     </rule>
   </pattern>
-<!--  Systems -->
+  <!--  Systems -->
   <!--
   HVACSystem has ID
   <severity> error
@@ -357,7 +357,7 @@
       </assert>
     </rule>
   </pattern>
-<!--  Schedules & Measures -->
+  <!--  Schedules & Measures -->
   <!--
   Schedule has ID
   <severity> error
@@ -380,7 +380,7 @@
       </assert>
     </rule>
   </pattern>
-<!--  Reports-->
+  <!--  Reports-->
   <!--
   Report has ID
   <severity> error
@@ -437,7 +437,7 @@
       </assert>
     </rule>
   </pattern>
-<!--  Contacts -->
+  <!--  Contacts -->
   <!--
   Contact has ID
   <severity> error

schematron/lib/measureElements.sch

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <sch:schema xmlns:sch="http://purl.oclc.org/dsdl/schematron">
   <sch:ns prefix="auc" uri="http://buildingsync.net/schemas/bedes-auc/2019"/>
-<!--
+  <!--
   Define measure elements required for successful roundtrip of scenarios through ATT -->
   <sch:pattern id="ms.seedATT.reqs">
     <sch:rule context="/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Measures/auc:Measure">

schematron/lib/scenarioElements.sch

@@ -48,18 +48,18 @@
   -->
   <pattern id="sc.benchmarkType.mainDetails.L000">
     <rule context="auc:Scenario[auc:ScenarioType/auc:Benchmark]/auc:ScenarioType/auc:Benchmark">
-<!--      <assert test="auc:BenchmarkType/*">-->
-      <assert test="count(auc:BenchmarkType/*) > 0" role="ERROR">
-        child element for 'auc:BenchmarkType' is REQUIRED AT LEAST ONCE for '<name/>’
+      <!--      <assert test="auc:BenchmarkType/*">-->
+      <assert test="count(auc:BenchmarkType/*) &gt; 0" role="ERROR">
+        child element for 'auc:BenchmarkType' is REQUIRED AT LEAST ONCE for '<name/>&#8217;
       </assert>
       <assert test="auc:BenchmarkTool" role="ERROR">
-        element 'auc:BenchmarkTool' is REQUIRED EXACTLY ONCE for '<name/>’
+        element 'auc:BenchmarkTool' is REQUIRED EXACTLY ONCE for '<name/>&#8217;
       </assert>
       <assert test="auc:BenchmarkYear" role="ERROR">
-        element 'auc:BenchmarkYear' is REQUIRED EXACTLY ONCE for '<name/>’
+        element 'auc:BenchmarkYear' is REQUIRED EXACTLY ONCE for '<name/>&#8217;
       </assert>
       <assert test="../../auc:LinkedPremises/auc:Building/auc:LinkedBuildingID" role="ERROR">
-        elements 'auc:LinkedPremises/auc:Building/auc:LinkedBuildingID' is REQUIRED EXACTLY ONCE for '<name/>’
+        elements 'auc:LinkedPremises/auc:Building/auc:LinkedBuildingID' is REQUIRED EXACTLY ONCE for '<name/>&#8217;
       </assert>
     </rule>
   </pattern>
@@ -87,17 +87,16 @@
       <assert test="count(auc:ResourceUses) = 1" role="ERROR">
         '<name/>' ID = '<value-of select="@ID"/>' MUST HAVE EXACTLY ONE 'auc:ResourceUses' child element
       </assert>
-      <assert test="count(auc:ResourceUses/auc:ResourceUse/auc:EnergyResource) >= 1" role="ERROR">
+      <assert test="count(auc:ResourceUses/auc:ResourceUse/auc:EnergyResource) &gt;= 1" role="ERROR">
         '<name/>' ID = '<value-of select="@ID"/>' MUST HAVE AT LEAST ONE 'auc:ResourceUses/auc:ResourceUse/auc:EnergyResource'
       </assert>
     </rule>
   </pattern>
-
   <!--
   Ensure that, within the context of a Measurement Scenario, each EnergyResource type has a EndUse='All end uses'
   <severity> error
   -->
-<!--  <pattern id="sc.measured.energyResource.allEndUses">
+  <!--  <pattern id="sc.measured.energyResource.allEndUses">
     <rule context="auc:Scenario[auc:ScenarioType/auc:CurrentBuilding/auc:CalculationMethod/auc:Measured]/auc:ResourceUses[auc:ResourceUse/auc:EnergyResource]">
       <let name="energyResourceTypes" value="auc:ResourceUse/auc:EnergyResource/text()"/>
       <let name="numEnergyResourceTypes" value="count(auc:ResourceUse/auc:EnergyResource/"

schematron/lib/siteBuildingElements.sch

@@ -22,9 +22,12 @@
       <assert test="($allCityCount = 1 and $allStateCount = 1 and $allClimateZoneCount &lt;= 1) or ($allCityCount &lt;= 1 and $allStateCount &lt;= 1 and $allClimateZoneCount = 1)" role="WARNING">
         elements 'auc:City' and 'auc:State' or element 'auc:ClimateZoneType//auc:ClimateZone' are RECOMMENDED EXACTLY ONCE at either the 'auc:Site' or 'auc:Building' level.
       </assert>
-      <assert test="false()" role="INFO">Number of 'auc:City' elements defined at the 'auc:Site' = <value-of select="$siteCityCount"/>, 'auc:Building' = <value-of select="$allCityCount - $siteCityCount"/></assert>
-      <assert test="false()" role="INFO">Number of 'auc:State' elements defined at the 'auc:Site' = <value-of select="$siteStateCount"/>, 'auc:Building' = <value-of select="$allStateCount - $siteStateCount"/></assert>
-      <assert test="false()" role="INFO">Number of 'auc:ClimateZoneType//auc:ClimateZone' elements defined at the 'auc:Site' = <value-of select="$siteClimateZoneCount"/>, 'auc:Building' = <value-of select="$allClimateZoneCount - $siteClimateZoneCount"/></assert>
+      <assert test="false()" role="INFO">Number of 'auc:City' elements defined at the 'auc:Site' = <value-of select="$siteCityCount"/>, 'auc:Building' = <value-of select="$allCityCount - $siteCityCount"/>
+      </assert>
+      <assert test="false()" role="INFO">Number of 'auc:State' elements defined at the 'auc:Site' = <value-of select="$siteStateCount"/>, 'auc:Building' = <value-of select="$allStateCount - $siteStateCount"/>
+      </assert>
+      <assert test="false()" role="INFO">Number of 'auc:ClimateZoneType//auc:ClimateZone' elements defined at the 'auc:Site' = <value-of select="$siteClimateZoneCount"/>, 'auc:Building' = <value-of select="$allClimateZoneCount - $siteClimateZoneCount"/>
+      </assert>
     </rule>
   </pattern>
 </schema>

schematron/lib/tests/data/ex01.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <auc:BuildingSync xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.githubusercontent.com/BuildingSync/schema/1c73127d389b779c6b74029be72c6e9ff3187113/BuildingSync.xsd">
   <auc:Facilities>
     <auc:Facility>

schematron/v2.0.0/examples/L100_OpenStudio_Simulation_01.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <auc:BuildingSync xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.githubusercontent.com/BuildingSync/schema/v2.0/BuildingSync.xsd">
   <auc:Facilities>
     <auc:Facility ID="Facility-69916113180740">

schematron/v2.0.0/examples/SEED_01.xml

@@ -1,4 +1,5 @@
-<auc:BuildingSync xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019"                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"                   xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.githubusercontent.com/BuildingSync/schema/v2.0/BuildingSync.xsd">
+<?xml version="1.0" encoding="UTF-8"?>
+<auc:BuildingSync xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 https://raw.githubusercontent.com/BuildingSync/schema/v2.0/BuildingSync.xsd">
   <auc:Facilities>
     <auc:Facility>
       <auc:Sites>

schematron/v2.0.0/v2-0-0_BRICR_SEED.sch

@@ -57,8 +57,8 @@
       <sch:assert test="count(./auc:ResourceUses/auc:ResourceUse[auc:EnergyResource=&quot;Natural gas&quot;]/auc:AnnualFuelUseConsistentUnits) = 1">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:ResourceUses/auc:ResourceUse[auc:EnergyResource="Natural gas"]/auc:AnnualFuelUseConsistentUnits" is RECOMMENDED</sch:assert>
       <sch:assert test="count(./auc:ScenarioType/auc:PackageOfMeasures/auc:CalculationMethod/auc:Modeled) = 1">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:ScenarioType/auc:PackageOfMeasures/auc:CalculationMethod/auc:Modeled" is RECOMMENDED</sch:assert>
       <sch:assert test="count(./auc:ScenarioType/auc:PackageOfMeasures/auc:MeasureIDs) = 1">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:ScenarioType/auc:PackageOfMeasures/auc:MeasureIDs" is RECOMMENDED</sch:assert>
-      <sch:assert test="count(./auc:ResourceUses/auc:ResourceUse) > 0">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:ResourceUses/auc:ResourceUse" is RECOMMENDED</sch:assert>
-      <sch:assert test="count(./auc:TimeSeriesData/auc:TimeSeries) > 0">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:TimeSeriesData/auc:TimeSeries" is RECOMMENDED</sch:assert>
+      <sch:assert test="count(./auc:ResourceUses/auc:ResourceUse) &gt; 0">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:ResourceUses/auc:ResourceUse" is RECOMMENDED</sch:assert>
+      <sch:assert test="count(./auc:TimeSeriesData/auc:TimeSeries) &gt; 0">[WARNING] element "/auc:BuildingSync/auc:Facilities/auc:Facility/auc:Reports/auc:Report/auc:Scenarios/auc:Scenario/auc:TimeSeriesData/auc:TimeSeries" is RECOMMENDED</sch:assert>
     </sch:rule>
   </sch:pattern>
 </sch:schema>