Merge pull request #9 from BuildingSync/revise-assets

Revise asset units handling

Author: kflemin

CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## Version 0.1.12
+
+Updated lxml dependency to 4.9.1
+
+## Version 0.1.11
+
+- Better units handling (distinction between predefined units and calculated units)
+- added "export_units" key to asset definition schema to indicate fields that will get a generated associated units field
+
+## Version 0.1.10
+
+Revise how asset units are handled
+
 ## Version 0.1.9
 
 Add new Heating, Cooling, WaterHeating, and LightingSystems assets

README.md

@@ -41,6 +41,8 @@ The pre-importer will identify assets defined in the `asset_definitions.json` fi
 
 1. `custom`. Use this method for particular asset that do not fit in the other categories; i.e. Heating Efficiency. Note that a dedicated method may need to be written to support this type of asset.
 
+When an asset has a unit associated with it, a separate asset will be generated to store the unit information. That asset will be named the same as the original asset, with ' Units' appended at the end.
+
 To test usage:
 
 ```bash
@@ -63,6 +65,7 @@ bp = BSyncProcessor(data=file_data)
 ## Assumptions
 1. Assuming 1 building per file
 1. Assuming sqft method uses "Conditioned" floor area for calculations. If not present, uses "Gross"
+1. Assuming averages that use served space area must be defined in Sections (LinkedSectionIDs). LinkedBuildingID is not used.
 
 ## TODO
 1. thermal zones: when spaces are listed within them with spaces (or multiple thermal zones), this would change the average setpoint calculations. Is this an exception or a normal case to handle?

buildingsync_asset_extractor/config/asset_definitions.json

@@ -5,98 +5,113 @@
       "key": "LightingSystemEfficiency",
       "name": "LightingSystemEfficiency",
       "export_name": "Lighting System Efficiency",
-      "type": "custom"
+      "type": "custom",
+      "export_units": true,
+      "units": "W/ft2"
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/LightingSystems",
       "key": "LightingSystem",
       "name": "LightingSystem",
       "export_name": "Lighting System Oldest",
-      "type": "age_oldest"
+      "type": "age_oldest",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/LightingSystems",
       "key": "LightingSystem",
       "name": "LightingSystem",
       "export_name": "Lighting System Average Age",
-      "type": "age_average"
+      "type": "age_average",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/HeatingSources/HeatingSource",
       "key": "AnnualHeatingEfficiencyValue",
       "name": "AnnualHeatingEfficiency",
       "export_name": "Heating System Efficiency",
-      "type": "custom"
+      "type": "custom",
+      "export_units": true
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/HeatingSources",
       "key": "HeatingSource",
       "name": "HeatingSource",
       "export_name": "Heating System Oldest",
-      "type": "age_oldest"
+      "type": "age_oldest",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/HeatingSources",
       "key": "HeatingSource",
       "name": "HeatingSource",
       "export_name": "Heating System Average Age",
-      "type": "age_average"
+      "type": "age_average",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/HeatingSources/HeatingSource",
       "key": "PrimaryFuel",
       "name": "PrimaryFuel",
       "export_name": "Heating Fuel Type",
-      "type": "custom"
+      "type": "custom",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/CoolingSources/CoolingSource",
       "key": "AnnualCoolingEfficiencyValue",
       "name": "AnnualCoolingEfficiency",
       "export_name": "Cooling System Efficiency",
-      "type": "custom"
+      "type": "custom",
+      "export_units": true
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/CoolingSources",
       "key": "CoolingSource",
       "name": "CoolingSource",
       "export_name": "Cooling System Oldest",
-      "type": "age_oldest"
+      "type": "age_oldest",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/HVACSystems/HVACSystem/HeatingAndCoolingSystems/CoolingSources",
       "key": "CoolingSource",
       "name": "CoolingSource",
       "export_name": "Cooling System Average Age",
-      "type": "age_average"
+      "type": "age_average",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/DomesticHotWaterSystems/DomesticHotWaterSystem",
       "key": "WaterHeaterEfficiency",
       "name": "WaterHeaterEfficiency",
       "export_name": "Hot Water System Efficiency",
-      "type": "custom"
+      "type": "custom",
+      "export_units": true
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/DomesticHotWaterSystems",
       "key": "DomesticHotWaterSystem",
       "name": "DomesticHotWaterSystem",
       "export_name": "Hot Water System Oldest",
-      "type": "age_oldest"
+      "type": "age_oldest",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/DomesticHotWaterSystems",
       "key": "DomesticHotWaterSystem",
       "name": "DomesticHotWaterSystem",
       "export_name": "Hot Water System Average Age",
-      "type": "age_average"
+      "type": "age_average",
+      "export_units": false
     },
     {
       "parent_path": "/BuildingSync/Facilities/Facility/Systems/DomesticHotWaterSystems/DomesticHotWaterSystem",
       "key": "PrimaryFuel",
       "name": "PrimaryFuel",
       "export_name": "Hot Water System Fuel Type",
-      "type": "custom"
+      "type": "custom",
+      "export_units": false
     }
   ]
 }

buildingsync_asset_extractor/main.py

@@ -37,11 +37,7 @@
 
 from buildingsync_asset_extractor.processor import BSyncProcessor
 
-# import glob
-# from pathlib import Path
-
-
-# # 1: regular test
+# 1: regular test
 filename = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'tests/files/completetest.xml')
 out_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'assets_output.json')
 out_file2 = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'assets_output2.json')
@@ -53,15 +49,17 @@
 bp.extract()
 bp.save(out_file)
 
-# does it work when already loaded?
-with open(filename, mode='rb') as file:
-    file_data = file.read()
+# # does it work when already loaded?
+# with open(filename, mode='rb') as file:
+#     file_data = file.read()
 
-bp = BSyncProcessor(data=file_data)
-bp.extract()
-bp.save(out_file2)
+# bp = BSyncProcessor(data=file_data)
+# bp.extract()
+# bp.save(out_file2)
 
 # 2: bigger test
+# import glob
+# from pathlib import Path
 # bae_tester_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', '..', '..', 'Desktop/BAE-tester/20220519_AT_BSXML')
 # find_path = os.path.join(bae_tester_dir, '*', '*.xml')
 
@@ -72,7 +70,10 @@
 # 	bp.extract()
 # 	bp.save(out_file)
 
+
 # 3: schema examples test
+# import glob
+# from pathlib import Path
 # bae_tester_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', '..', 'bsync-schema', 'examples')
 # find_path = os.path.join(bae_tester_dir, '*.xml')