openstudio-common-measures 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 541beaf68995c607e48fc05f7cfe05668d012e2e87bb2d443b6ebbe55f2159c9
-  data.tar.gz: 5be5b201dff7796ba33d3bda9b8eeb65de28338d66881369c22359c3a28e357d
+  metadata.gz: aef91215d3cc45d5b5686f4c94e82b7aa44d2610cdeac9de7019b4706233715c
+  data.tar.gz: d70ac47cbce72e9b8e79cad8e864a01b7271d8ff4d88c070e96b06cba2ccdfb8
 SHA512:
-  metadata.gz: a36f9fdf655284051f5d57e006ff1dda8b024fd983bc81ef4da4387279a056425b795f223247f6abaea87c95a63fe2e07eee9b5cc3416c0cabd0e18f5fc03bd4
-  data.tar.gz: 677cd178a8d2ee08d9d2b241cd9727b82e5d8a531b2bb07a58c793c3dc85b23384312cb74883fb2bf356a223d95beb1edf62dccecea1e7639b5c423537a535e2
+  metadata.gz: 96765829e90d5133823178efdccd0983e523c291f0d2fc620c1a04084d83d9cdf8aa07f52320cf83acc10c46b0ef28681637d5e88425e985eb9e37ab1b30a777
+  data.tar.gz: 646027cdd27160feb03555e26f2104c05660b3dfa8f1b852254c1b87fa91c9e80871a16cf36b114d84408726cc103e87a0a637cfe805cca9f6c8a45b84e5bd7d

data/.gitignore

@@ -12,6 +12,7 @@
 /test/
 /lib/measures/test_results
 /lib/measures/*/tests/output
+/lib/measures/*/tests/files
 /lib/measures/staged
 
 .rubocop*s3*

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
+
+require: rubocop-performance
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
+    - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Version 0.4.0
 
+* Support for OpenStudio 3.3 (upgrade to extension gem 0.5.1 and standards gem 0.2.15)
+* Fixed [#80]( https://github.com/NREL/openstudio-common-measures-gem/pull/80 ), Custom emissions reporting measure
+* Fixed [#82]( https://github.com/NREL/openstudio-common-measures-gem/pull/82 ), adding compatibility matrix and contribution policy
+* Fixed [#84]( https://github.com/NREL/openstudio-common-measures-gem/pull/84 ), Add latest CO2 CSVs from LBNL
+* Adding surface search to view model and view data commited by macumber
+
+## Version 0.4.0
+
 * Support Ruby ~> 2.7
 * Support for OpenStudio 3.2 (upgrade to extension gem 0.4.2 and standards gem 0.2.13)
 * Add EV measure load files

data/README.md

@@ -34,6 +34,20 @@ bundle exec rake openstudio:test_with_openstudio
 
 - [ ] Update measures to follow coding standards
 
+# Compatibility Matrix
+
+|OpenStudio Common Measures Gem|OpenStudio|Ruby|
+|:--------------:|:----------:|:--------:|
+| 0.5.0  | 3.3      | 2.7    |
+| 0.4.0 - 0,4.2 | 3.2      | 2.7    |
+| 0.3.0 - 0.3.2  | 3.1      | 2.5    |
+| 0.2.0 - 0.2.1  | 3.0      | 2.5    |
+| 0.1.2 and below | 2.9 and below      | 2.2.4    |
+
+# Contributing 
+
+Please review the [OpenStudio Contribution Policy](https://openstudio.net/openstudio-contribution-policy) if you would like to contribute code to this gem.
+
 # Releasing
 
 * Update CHANGELOG.md

data/lib/measures/ReportModelChanges/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>report_model_changes</name>
   <uid>6d66b426-908f-4528-9fe5-523b9d2f49c5</uid>
-  <version_id>00be21f8-d770-48fa-bc1e-4ecfd626e5dd</version_id>
-  <version_modified>20210423T144506Z</version_modified>
+  <version_id>a4712e0a-6080-4534-a6b8-16e9312c623e</version_id>
+  <version_modified>20210708T213307Z</version_modified>
   <xml_checksum>1E1F8B97</xml_checksum>
   <class_name>ReportModelChanges</class_name>
   <display_name>ReportModelChanges</display_name>

data/lib/measures/add_ems_emissions_reporting/LICENSE.MD.txt

@@ -0,0 +1,15 @@
+
+
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/add_ems_emissions_reporting/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted 
+provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED 
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/measures/add_ems_emissions_reporting/README.md

@@ -0,0 +1,17 @@
+## Add EMS to Report Emissions
+## Description
+This measure reports emissions based on user-provided CSVs.
+
+## Modeler Description
+This measure uses EnergyPlus' Energy Management System to log and report emissions based on user provided CSV file(s).
+
+## Measure Type
+EnergyPlusMeasure
+
+## Arguments
+## Subregion
+Name: sub_regn, Type: string, Units: none, Required: true, Model Dependent: false. This argument is the eGrid subregion. Options are: AZNM, CAMX, ERCT, FRCC, MROE, MROW, NEWE, NWPP, NYST, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC. Default is RMPA. 
+## Future Year
+Name: fut_year, Type: integer, Units: none, Required: true, Model Dependent: false. This argument is the future year of interest. Options are: 2020 to 2050 in two year increments. Default is 2030.
+## Historical Year
+Name: his_year, Type: integer, Units: none, Required: true, Model Dependent: false. This argument is the historical year of interest. Options are: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019. Default is 2010.

data/lib/measures/add_ems_emissions_reporting/measure.rb

@@ -0,0 +1,268 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'csv'
+require 'openstudio-extension'
+require 'openstudio/extension/core/os_lib_helper_methods'
+
+# start the measure
+class AddEMSEmissionsReporting < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    return 'Add EMS to Report Emissions'
+  end
+
+  # human readable description
+  def description
+    return 'This measure reports emissions based on user-provided future and historical years as well as future, historical hourly, and historical annual subregions.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'This measure uses the EnergyPlus Energy Management System to log and report emissions based on user-provided future and historical years as well as future, historical hourly, and historical annual subregions.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # future subregion
+    future_subregion = OpenStudio::Measure::OSArgument.makeStringArgument('future_subregion', true)
+    future_subregion.setDisplayName('Future subregion')
+    future_subregion.setDescription('Future subregion. Options are: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc')
+    future_subregion.setDefaultValue('RMPAc')
+    args << future_subregion
+
+    # historical hourly subregion
+    hourly_historical_subregion = OpenStudio::Measure::OSArgument.makeStringArgument('hourly_historical_subregion', true)
+    hourly_historical_subregion.setDisplayName('Historical hourly subregion')
+    hourly_historical_subregion.setDescription('Historical hourly subregion. Options are: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas')
+    hourly_historical_subregion.setDefaultValue('Rocky Mountains')
+    args << hourly_historical_subregion
+
+    # historical annual subregion
+    annual_historical_subregion = OpenStudio::Measure::OSArgument.makeStringArgument('annual_historical_subregion', true)
+    annual_historical_subregion.setDisplayName('Historical annual subregion')
+    annual_historical_subregion.setDescription('Historical annual subregion. Options are: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC')
+    annual_historical_subregion.setDefaultValue('RMPA')
+    args << annual_historical_subregion
+
+    # future year
+    future_year = OpenStudio::Measure::OSArgument.makeIntegerArgument('future_year', true)
+    future_year.setDisplayName('Future Year')
+    future_year.setDescription('Future Year. Options are: 2020 to 2050 in two year increments')
+    future_year.setDefaultValue(2020)
+    args << future_year
+
+    # hourly historical year
+    hourly_historical_year = OpenStudio::Measure::OSArgument.makeIntegerArgument('hourly_historical_year', true)
+    hourly_historical_year.setDisplayName('Hourly Historical Year')
+    hourly_historical_year.setDescription('Hourly Historical Year. Options are: 2019.')
+    hourly_historical_year.setDefaultValue(2019)
+    args << hourly_historical_year
+
+    # annual historical year
+    annual_historical_year = OpenStudio::Measure::OSArgument.makeIntegerArgument('annual_historical_year', true)
+    annual_historical_year.setDisplayName('Annual Historical Year')
+    annual_historical_year.setDescription('Annual Historical Year. Options are: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.')
+    annual_historical_year.setDefaultValue(2019)
+    args << annual_historical_year
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, usr_args)
+    super(model, runner, usr_args)
+
+    # use the built-in error checking
+    return false unless runner.validateUserArguments(arguments(model), usr_args)
+
+    # assign the user inputs to variables
+    future_subregion = runner.getStringArgumentValue('future_subregion', usr_args)
+    hourly_historical_subregion = runner.getStringArgumentValue('hourly_historical_subregion', usr_args)
+    annual_historical_subregion = runner.getStringArgumentValue('annual_historical_subregion', usr_args)
+    future_year = runner.getIntegerArgumentValue('future_year', usr_args)
+    hourly_historical_year = runner.getIntegerArgumentValue('hourly_historical_year', usr_args)
+    annual_historical_year = runner.getIntegerArgumentValue('annual_historical_year', usr_args)
+
+    fut_hr_path = "#{__dir__}/resources/future_hourly_co2e_#{future_year}.csv"
+    his_hr_path = "#{__dir__}/resources/historical_hourly_co2e_#{hourly_historical_year}.csv"
+    fut_yr_path = "#{__dir__}/resources/future_annual_co2e.csv"
+    his_yr_path = "#{__dir__}/resources/historical_annual_co2e.csv"
+
+    # find external files
+    if ((File.exist?(fut_hr_path)) and (File.exist?(fut_yr_path)) and (File.exist?(his_hr_path)) and (File.exist?(his_yr_path)))
+      fut_hr_file = OpenStudio::Model::ExternalFile.getExternalFile(model, fut_hr_path)
+      his_hr_file = OpenStudio::Model::ExternalFile.getExternalFile(model, his_hr_path)
+      fut_yr_file = OpenStudio::Model::ExternalFile.getExternalFile(model, fut_yr_path)
+      his_yr_file = OpenStudio::Model::ExternalFile.getExternalFile(model, his_yr_path)
+      if ((fut_hr_file.is_initialized) and (his_hr_file.is_initialized) and (fut_yr_file.is_initialized) and (his_yr_file.is_initialized))
+        fut_hr_file = fut_hr_file.get
+        his_hr_file = his_hr_file.get
+        fut_yr_file = fut_yr_file.get
+        his_yr_file = his_yr_file.get
+        fut_hr_data = CSV.read(fut_hr_path, headers: true)
+        his_hr_data = CSV.read(his_hr_path, headers: true)
+        fut_yr_data = CSV.read(fut_yr_path, headers: true)
+        his_yr_data = CSV.read(his_yr_path, headers: true)
+      end
+    else
+      runner.registerError("Could not find CSV file at one of more of the following paths: #{fut_hr_path}, #{his_hr_path}, #{fut_yr_path}, or #{his_yr_path}")
+      return false
+    end
+
+    # add schedule type limits for schedule file
+    lim_type = OpenStudio::Model::ScheduleTypeLimits.new(model)
+    lim_type.setName('Emissions Sch File Type Limits')
+
+    # add future schedule file
+    sch_file = OpenStudio::Model::ScheduleFile.new(fut_hr_file)
+    sch_file.setName("#{future_subregion} #{future_year} Future Hourly Emissions Sch")
+    sch_file.setScheduleTypeLimits(lim_type)
+    sch_file.setColumnNumber(fut_hr_data.headers.index(future_subregion) + 1)
+    sch_file.setRowstoSkipatTop(1)
+    sch_file.setNumberofHoursofData(8760)
+    sch_file.setColumnSeparator('Comma')
+    sch_file.setInterpolatetoTimestep(false)
+    sch_file.setMinutesperItem(60)
+
+    # add historical schedule file
+    sch_file = OpenStudio::Model::ScheduleFile.new(his_hr_file)
+    sch_file.setName("#{hourly_historical_subregion} #{hourly_historical_year} Historical Hourly Emissions Sch")
+    sch_file.setScheduleTypeLimits(lim_type)
+    sch_file.setColumnNumber(his_hr_data.headers.index(hourly_historical_subregion) + 1)
+    sch_file.setRowstoSkipatTop(1)
+    sch_file.setNumberofHoursofData(8760)
+    sch_file.setColumnSeparator('Comma')
+    sch_file.setInterpolatetoTimestep(false)
+    sch_file.setMinutesperItem(60)
+
+    # add EMS sensor for future schedule file
+    sch_sens = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Schedule Value')
+    sch_sens.setKeyName("#{future_subregion} #{future_year} Future Hourly Emissions Sch")
+    sch_sens.setName('Fut_Sen')
+
+    # add EMS sensor for historical schedule file
+    sch_sens = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Schedule Value')
+    sch_sens.setKeyName("#{hourly_historical_subregion} #{hourly_historical_year} Historical Hourly Emissions Sch")
+    sch_sens.setName('His_Sen')
+
+    # add whole-building electricity sensor
+    sch_sens = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Facility Total Purchased Electricity Energy')
+    sch_sens.setKeyName('Whole Building')
+    sch_sens.setName('Ele_Sen')
+
+    ems_prgm = OpenStudio::Model::EnergyManagementSystemProgram.new(model)
+    ems_prgm.setName('Emissions_Calc_Prgm')
+    ems_prgm.addLine('SET fut_hr_val = Fut_Sen')
+    ems_prgm.addLine('SET his_hr_val = His_Sen')
+    fut_yr_data.each {|r| ems_prgm.addLine("SET fut_yr_val = #{r[future_subregion]}") if r[0].to_i == future_year}
+    his_yr_data.each {|r| ems_prgm.addLine("SET his_yr_val = #{r[annual_historical_subregion]}") if r[0].to_i == annual_historical_year}
+    ems_prgm.addLine('SET elec = Ele_Sen')
+    ems_prgm.addLine('SET conv = 1000000 * 60 * 60') # J to MWh (1000000J/MJ * 60hr/min * 60 min/sec)
+    ems_prgm.addLine('SET fut_hr = fut_hr_val * elec / conv')
+    ems_prgm.addLine('SET his_hr = his_hr_val * elec / conv')
+    ems_prgm.addLine('SET fut_yr = fut_yr_val * elec / conv')
+    ems_prgm.addLine('SET his_yr = his_yr_val * elec / conv')
+
+    # add EMS program calling manager
+    mgr_prgm = OpenStudio::Model::EnergyManagementSystemProgramCallingManager.new(model)
+    mgr_prgm.setName('Emissions Calc Prgm')
+    mgr_prgm.setCallingPoint('EndOfSystemTimestepBeforeHVACReporting')
+    mgr_prgm.setProgram(ems_prgm, 0)
+
+    # add future hourly EMS output variable
+    ems_var1 = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'fut_hr')
+    ems_var1.setName("#{future_subregion}_#{future_year}_Hourly_Emissions_Var")
+    ems_var1.setEMSVariableName('fut_hr')
+    ems_var1.setTypeOfDataInVariable('Summed')
+    ems_var1.setUpdateFrequency('SystemTimestep')
+    ems_var1.setEMSProgramOrSubroutineName(ems_prgm)
+    ems_var1.setUnits('kg')
+
+    # add historical hourly EMS output variable
+    ems_var2 = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'his_hr')
+    ems_var2.setName("#{hourly_historical_subregion.gsub(' ','_')}_#{hourly_historical_year}_Hourly_Emissions_Var")
+    ems_var2.setEMSVariableName('his_hr')
+    ems_var2.setTypeOfDataInVariable('Summed')
+    ems_var2.setUpdateFrequency('SystemTimestep')
+    ems_var2.setEMSProgramOrSubroutineName(ems_prgm)
+    ems_var2.setUnits('kg')
+
+    # add future annual EMS output variable
+    ems_var3 = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'fut_yr')
+    ems_var3.setName("#{future_subregion}_#{future_year}_Annual_Emissions_Var")
+    ems_var3.setEMSVariableName('fut_yr')
+    ems_var3.setTypeOfDataInVariable('Summed')
+    ems_var3.setUpdateFrequency('SystemTimestep')
+    ems_var3.setEMSProgramOrSubroutineName(ems_prgm)
+    ems_var3.setUnits('kg')
+
+    # add historical annual EMS output variable
+    ems_var4 = OpenStudio::Model::EnergyManagementSystemOutputVariable.new(model, 'his_yr')
+    ems_var4.setName("#{annual_historical_subregion}_#{annual_historical_year}_Annual_Emissions_Var")
+    ems_var4.setEMSVariableName('his_yr')
+    ems_var4.setTypeOfDataInVariable('Summed')
+    ems_var4.setUpdateFrequency('SystemTimestep')
+    ems_var4.setEMSProgramOrSubroutineName(ems_prgm)
+    ems_var4.setUnits('kg')
+
+    # add future hourly reporting output variable
+    out_var1 = OpenStudio::Model::OutputVariable.new("#{future_subregion}_#{future_year}_Hourly_Emissions_Var", model)
+    out_var1.setKeyValue('EMS')
+    out_var1.setReportingFrequency('hourly')
+
+    # add historical hourly reporting output variable
+    out_var2 = OpenStudio::Model::OutputVariable.new("#{hourly_historical_subregion.gsub(' ','_')}_#{hourly_historical_year}_Hourly_Emissions_Var", model)
+    out_var2.setKeyValue('EMS')
+    out_var2.setReportingFrequency('hourly')
+
+    # add future annual reporting output variable
+    out_var3 = OpenStudio::Model::OutputVariable.new("#{future_subregion}_#{future_year}_Annual_Emissions_Var", model)
+    out_var3.setKeyValue('EMS')
+    out_var3.setReportingFrequency('hourly')
+
+    # add historical annual reporting output variable
+    out_var4 = OpenStudio::Model::OutputVariable.new("#{annual_historical_subregion}_#{annual_historical_year}_Annual_Emissions_Var", model)
+    out_var4.setKeyValue('EMS')
+    out_var4.setReportingFrequency('hourly')
+
+    return true
+  end
+end
+
+# register the measure to be used by the application
+AddEMSEmissionsReporting.new.registerWithApplication

data/lib/measures/add_ems_emissions_reporting/measure.xml

@@ -0,0 +1,247 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>add_ems_emissions_reporting</name>
+  <uid>e8fe9153-5e70-4769-afa0-6da0045aa529</uid>
+  <version_id>0395788b-e770-4887-bec9-149c0b88bcf9</version_id>
+  <version_modified>20211013T192425Z</version_modified>
+  <xml_checksum>976EB6EB</xml_checksum>
+  <class_name>AddEMSEmissionsReporting</class_name>
+  <display_name>Add EMS to Report Emissions</display_name>
+  <description>This measure reports emissions based on user-provided future and historical years as well as future, historical hourly, and historical annual subregions.</description>
+  <modeler_description>This measure uses the EnergyPlus Energy Management System to log and report emissions based on user-provided future and historical years as well as future, historical hourly, and historical annual subregions.</modeler_description>
+  <arguments>
+    <argument>
+      <name>future_subregion</name>
+      <display_name>Future subregion</display_name>
+      <description>Future subregion. Options are: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc</description>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>RMPAc</default_value>
+    </argument>
+    <argument>
+      <name>hourly_historical_subregion</name>
+      <display_name>Historical hourly subregion</display_name>
+      <description>Historical hourly subregion. Options are: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas</description>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Rocky Mountains</default_value>
+    </argument>
+    <argument>
+      <name>annual_historical_subregion</name>
+      <display_name>Historical annual subregion</display_name>
+      <description>Historical annual subregion. Options are: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC</description>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>RMPA</default_value>
+    </argument>
+    <argument>
+      <name>future_year</name>
+      <display_name>Future Year</display_name>
+      <description>Future Year. Options are: 2020 to 2050 in two year increments</description>
+      <type>Integer</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>2020</default_value>
+    </argument>
+    <argument>
+      <name>hourly_historical_year</name>
+      <display_name>Hourly Historical Year</display_name>
+      <description>Hourly Historical Year. Options are: 2019.</description>
+      <type>Integer</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>2019</default_value>
+    </argument>
+    <argument>
+      <name>annual_historical_year</name>
+      <display_name>Annual Historical Year</display_name>
+      <description>Annual Historical Year. Options are: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.</description>
+      <type>Integer</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>2019</default_value>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Equipment.Equipment Controls</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
+    </file>
+    <file>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>8EA06A27</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>D90928F0</checksum>
+    </file>
+    <file>
+      <filename>future_annual_co2e.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>68D6F2FF</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2020.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>7F6FBFEF</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2022.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>B3366E3F</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2024.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>B2CCE349</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2026.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>A4F2D252</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2028.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>300261DB</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2030.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>3915B70B</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2032.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>DB3FE58C</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2034.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>6D1F32C2</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2036.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>0F38FDD7</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2038.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>87850670</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2040.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>546B4C66</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2042.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>ACB58818</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2044.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>6304E0BA</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2046.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>31F8B3E2</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2048.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>6AAE5452</checksum>
+    </file>
+    <file>
+      <filename>future_hourly_co2e_2050.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>EA30D696</checksum>
+    </file>
+    <file>
+      <filename>historical_annual_co2e.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>5001E3BC</checksum>
+    </file>
+    <file>
+      <filename>historical_hourly_co2e_2019.csv</filename>
+      <filetype>csv</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>6C952ECC</checksum>
+    </file>
+    <file>
+      <filename>add_ems_emissions_reporting_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>2124C39D</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.5.1</identifier>
+        <min_compatible>2.5.1</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>097E1A3B</checksum>
+    </file>
+  </files>
+</measure>