Merge pull request #16 from BuildingSync/Add-GHG-Classes

Add GHG Emissions

Author: nllong

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 21.9b0 # Replace by any tag/version: https://github.com/psf/black/tags
+    rev: 22.3.0
     hooks:
       - id: black
         language_version: python3 # Should be a command that runs python3.6+

bsyncpy/bsync.py

@@ -1598,6 +1598,27 @@ class AnnualWaterCostSavings(BSElement):
     element_type = "xs:decimal"
 
 
+# AnnualSavingsAverageGHGEmissions
+class AnnualSavingsAverageGHGEmissions(BSElement):
+    """Average GHG emissions savings per year. (MtCO2e/year)"""
+
+    element_type = "xs:decimal"
+
+
+# AnnualSavingsMarginalGHGEmissions
+class AnnualSavingsMarginalGHGEmissions(BSElement):
+    """Marginal GHG emissions savings per year. (MtCO2e/year)"""
+
+    element_type = "xs:decimal"
+
+
+# AnnualSavingsGHGEmissionIntensity
+class AnnualSavingsGHGEmissionIntensity(BSElement):
+    """Annual GHG emissions intensity savings per year. (kg CO2e/ft2/year)"""
+
+    element_type = "xs:decimal"
+
+
 # SimplePayback
 class SimplePayback(BSElement):
     """The length of time required for the investment to pay for itself. (yrs)"""
@@ -2343,6 +2364,15 @@ class LinkedTimeSeriesID(BSElement):
     "IDref",  # IDREF
 ]
 
+# ResourceUseType.Emissions.Emission.EmissionsLinkedTimeSeriesIDs.EmissionsLinkedTimeSeriesID
+class EmissionsLinkedTimeSeriesID(BSElement):
+    pass
+
+
+EmissionsLinkedTimeSeriesID.element_attributes = [
+    "IDref",  # IDREF
+]
+
 # ResourceUseType.UtilityIDs.UtilityID
 class UtilityID(BSElement):
     """ID of utility associated with this resource use."""
@@ -2385,18 +2415,37 @@ class EmissionsFactorSource(BSElement):
 
 # ResourceUseType.Emissions.Emission.GHGEmissions
 class GHGEmissions(BSElement):
-    """Emissions that result in gases that trap heat in the atmosphere. (kgCO2e)"""
+    """Emissions that result in gases that trap heat in the atmosphere. (MtCO2e)"""
+
+    element_type = "xs:decimal"
+
+
+# ResourceUseType.Emissions.Emission.GHGEmissionsIntensity
+class GHGEmissionsIntensity(BSElement):
+    """GHG Emission Intensity (kg CO2e/ft2)"""
 
     element_type = "xs:decimal"
 
 
 # ResourceUseType.Emissions.Emission.AvoidedEmissions
 class AvoidedEmissions(BSElement):
-    """The avoided Greenhouse gas (GHG) emissions resulting from a renewable energy source or a system. (kgCO2e)"""
+    """The avoided Greenhouse gas (GHG) emissions resulting from a renewable energy source or a system. (MtCO2e)"""
+
+    element_type = "xs:decimal"
+
+
+# ResourceUseType.Emissions.Emission.EmissionsLinkedTimeSeriesIDs
+class EmissionsLinkedTimeSeriesIDs(BSElement):
+    """Links to all time series data used to calculate the total GHG Emissions"""
 
     element_type = "xs:decimal"
 
 
+EmissionsLinkedTimeSeriesIDs.element_children = [
+    ("EmissionsLinkedTimeSeriesID", EmissionsLinkedTimeSeriesID),
+]
+
+
 # AllResourceTotalType.SiteEnergyUseIntensity
 class SiteEnergyUseIntensity(BSElement):
     """The Site Energy Use divided by the premises gross floor area. (kBtu/ft2)"""
@@ -2554,6 +2603,7 @@ class TimeSeriesReadingQuantity(BSElement):
         "Current Angle",
         "Demand",
         "Frequency",
+        "Greenhouse Gas Emissions",
         "Power",
         "Power Factor",
         "Energy",
@@ -10031,7 +10081,9 @@ class Emission(BSElement):
     ("EmissionsFactor", EmissionsFactor),
     ("EmissionsFactorSource", EmissionsFactorSource),
     ("GHGEmissions", GHGEmissions),
+    ("GHGEmissionsIntensity", GHGEmissionsIntensity),
     ("AvoidedEmissions", AvoidedEmissions),
+    ("EmissionsLinkedTimeSeriesIDs", EmissionsLinkedTimeSeriesIDs),
 ]
 
 # TimeSeriesType.IntervalDurationUnits
@@ -12744,6 +12796,9 @@ class Target(BSElement):
     ("InternalRateOfReturn", InternalRateOfReturn),
     ("AssetScore", AssetScore),
     ("ENERGYSTARScore", ENERGYSTARScore),
+    ("AnnualSavingsAverageGHGEmissions", AnnualSavingsAverageGHGEmissions),
+    ("AnnualSavingsMarginalGHGEmissions", AnnualSavingsMarginalGHGEmissions),
+    ("AnnualSavingsGHGEmissionIntensity", AnnualSavingsGHGEmissionIntensity),
 ]
 
 # AnnualSavingsByFuels
@@ -12772,6 +12827,21 @@ class WaterUse(BSElement):
 
         element_type = "xs:decimal"
 
+    class AnnualAverageGHGEmissions(BSElement):
+        """Annual Average GHG Emissions. (MtCO2e)"""
+
+        element_type = "xs:decimal"
+
+    class AnnualMarginalGHGEmissions(BSElement):
+        """Annual Marginal GHG Emissions. (MtCO2e)"""
+
+        element_type = "xs:decimal"
+
+    class AnnualGHGEmissionIntensity(BSElement):
+        """Annual GHG Emission Intensity. (kg CO2e/ft2/year)"""
+
+        element_type = "xs:decimal"
+
 
 AllResourceTotalType.element_attributes = [
     "ID",  # ID
@@ -12782,6 +12852,9 @@ class WaterUse(BSElement):
     ("ResourceBoundary", ResourceBoundary),
     ("SiteEnergyUse", AllResourceTotalType.SiteEnergyUse),
     ("SiteEnergyUseIntensity", SiteEnergyUseIntensity),
+    ("AnnualAverageGHGEmissions", AllResourceTotalType.AnnualAverageGHGEmissions),
+    ("AnnualMarginalGHGEmissions", AllResourceTotalType.AnnualMarginalGHGEmissions),
+    ("AnnualGHGEmissionIntensity", AllResourceTotalType.AnnualGHGEmissionIntensity),
     ("SourceEnergyUse", AllResourceTotalType.SourceEnergyUse),
     ("SourceEnergyUseIntensity", SourceEnergyUseIntensity),
     ("BuildingEnergyUse", BuildingEnergyUse),
@@ -14731,6 +14804,9 @@ class PackageOfMeasures(BSElement):
     ("AssetScore", AssetScore),
     ("ENERGYSTARScore", ENERGYSTARScore),
     ("UserDefinedFields", UserDefinedFields),
+    ("AnnualSavingsAverageGHGEmissions", AnnualSavingsAverageGHGEmissions),
+    ("AnnualSavingsMarginalGHGEmissions", AnnualSavingsMarginalGHGEmissions),
+    ("AnnualSavingsGHGEmissionIntensity", AnnualSavingsGHGEmissionIntensity),
 ]
 
 # ScenarioType.ResourceUses.ResourceUse
@@ -14790,6 +14866,9 @@ class MeasureSavingsAnalysis(BSElement):
     ("SimplePayback", SimplePayback),
     ("NetPresentValue", NetPresentValue),
     ("InternalRateOfReturn", InternalRateOfReturn),
+    ("AnnualSavingsAverageGHGEmissions", AnnualSavingsAverageGHGEmissions),
+    ("AnnualSavingsMarginalGHGEmissions", AnnualSavingsMarginalGHGEmissions),
+    ("AnnualSavingsGHGEmissionIntensity", AnnualSavingsGHGEmissionIntensity),
 ]
 
 # ReportType.Utilities.Utility
@@ -16442,6 +16521,9 @@ class ScenarioType(BSElement):
     ("InternalRateOfReturn", InternalRateOfReturn),
     ("AssetScore", AssetScore),
     ("ENERGYSTARScore", ENERGYSTARScore),
+    ("AnnualSavingsAverageGHGEmissions", AnnualSavingsAverageGHGEmissions),
+    ("AnnualSavingsMarginalGHGEmissions", AnnualSavingsMarginalGHGEmissions),
+    ("AnnualSavingsGHGEmissionIntensity", AnnualSavingsGHGEmissionIntensity),
 ]
 ScenarioType.ScenarioType.element_children = [
     ("CurrentBuilding", CurrentBuilding),