openstudio-geb 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d4e3aa64d8c0c4b47747c35b4fead34ddf0b0bdb1700832b9b1aa4028114d5a
-  data.tar.gz: 0437b10703119326e2c34600effbff9b9a80a86965393e05841f39d8f01fb493
+  metadata.gz: d3d8c2734323d3dac92db55bde46204f9c052b560d38e4d6bfe96875056c43fe
+  data.tar.gz: 94dcdbe7b1feb6e66d9177a4839b62be0250de781acdaf323ad3977966200f0b
 SHA512:
-  metadata.gz: c3556d1e23800d744b5406a04e959aa178399ae59ebd937771948949b34d56d3ac7c27d76227ddadacdc64848a1c777e7bb70b2ac292285f4688b53939f8dd2a
-  data.tar.gz: 457854c8ae8d77a8dd46d800a648fb80eb72089773a29673a2964e2d6a37188b0af030cf490727976c6275972d90b3771b1d6810ef01b78643779792cb680a71
+  metadata.gz: a015c54e0e3b62a8286b5d8ad7b328708deb654aa2c13cd945564309f1f3b2599bda685b522a3509c4406a6bfd820ec4f4edd6d1d5e3081eab5d7ff5d12fe8a8
+  data.tar.gz: 2ec84897e39c80f0c0a1e19fad7c535048ef189e4331be54947efee6d5717bb97475b55a81a0cea1cfb1c831b18fbbf804d6983ab1e5fa6fa1d46a321e0798ef

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # OpenStudio GEB Gem
 
+## Version 0.4.0
+- Support for OpenStudio 3.7 (upgrade to standards gem 0.5.0, extension gem 0.7.0)
+
 ## Version 0.3.0
 - Support for OpenStudio 3.6 (upgrade to standards gem 0.4.0, extension gem 0.6.1)
 
@@ -13,4 +16,4 @@
 
 ## Versions 0.1.0 and 0.1.1
 
-- Initial releases
+- Initial releases

data/Gemfile

@@ -24,4 +24,4 @@ gem 'simplecov', '~> 0.18.2'
 # pin this dependency to avoid unicode_normalize error
 gem 'addressable', '2.8.1'
 # pin this dependency to avoid using racc dependency (which has native extensions)
-gem 'parser', '3.2.2.2'
+gem 'parser', '3.2.2.2'

data/README.md

@@ -1,6 +1,13 @@
 # Openstudio Geb Gem
 
-TODO: Add a description of this gem
+The OpenStudio GEB measure gem is an open source OpenStudio library that can be plug-and-play into existing 
+OpenStudio-based platforms. It was developed by Lawrence Berkeley National Laboratory since 2020. It now has
+22 GEB measures implemented, spanning various building systems like lighting, plug load, envelope, hvac, 
+domestic hot water, electric vehicle, and PV. 
+
+Three of the GEB measures in this gem were integrated into NREL's [URBANopt](https://docs.urbanopt.net/) platform to support load 
+flexibility analysis. They are "Reduce EPD by Percentage for Peak Hours", "Adjust thermostat setpoint 
+by degrees for peak hours", and "Add Chilled Water Storage Tank".
 
 ## Installation
 
@@ -12,26 +19,36 @@ gem 'openstudio-geb'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install 'openstudio-geb'
 
-## Usage
-
-To be filled out later. 
-
-## TODO
-
-- [ ] Remove measures from OpenStudio-Measures to standardize on this location
-- [ ] Update measures to code standards
-- [ ] Review and fill out the gemspec file with author and gem description
-
-# Releasing
-
-* Update change log
-* Update version in `/lib/openstudio/openstudio-geb/version.rb`
-* Merge down to master
-* Release via github
-* run `rake release` from master
+## Available GEB measures list
+* Reduce EPD by percentage for peak hours
+* Reduce LPD by percentage for peak hours
+* Adjust thermostat setpoint by degrees for peak hours
+* Reduce domestic hot water use for peak hours
+* Average ventilation for peak hours
+* Add chilled water storage tank
+* Add electrochromic windows
+* add_exterior_blinds_and_control
+* add_interior_blinds_and_control
+* Add fan assist night ventilation with hybrid control
+* Add natural ventilation with hybrid control
+* Add heat pump water heater
+* Adjust domestic hot water setpoint
+* Add rooftop PV
+* Add electric vehicle charging load
+* Add ceiling fan
+* Apply dynamic coating to roof wall
+* Enable demand controlled ventilation
+* Enable occupancy-driven lighting
+* Precooling
+* Preheating
+* Reduce exterior lighting loads
+
+## Contact
+Kaiyu Sun (Lead developer), [ksun@lbl.gov](mailto:ksun@lbl.gov)\
+Tianzhen Hong (Principal investigator), [thong@lbl.gov](mailto:thong@lbl.gov)

data/lib/measures/GEB Metrics Report/resources/os_lib_reporting.rb

@@ -1,8 +1,8 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
-# See also https://openstudio.net/license
-# *******************************************************************************
-
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
 require 'json'
 require 'openstudio-standards'
 require 'yaml'
@@ -447,7 +447,6 @@ module OsLib_Reporting
     winter_demand_geb_values = []
     step_per_h = model.getTimestep.numberOfTimestepsPerHour.to_f
     floor_area_ft2 = OpenStudio.convert(model.building.get.floorArea.to_f, 'm^2', 'ft^2').get
-    puts "*************step 1*************"
 
     datetimes.each_with_index do |time, idx|
       # get results for the event day
@@ -479,14 +478,6 @@ module OsLib_Reporting
       end
     end
 
-    puts "event_day_times: #{event_day_times.inspect}"
-    puts "event_day_base_values: #{event_day_base_values.inspect}"
-    puts "event_day_geb_values: #{event_day_geb_values.inspect}"
-    puts "summer_demand_base_values.size: #{summer_demand_base_values.size}"
-    puts "summer_demand_geb_values.size: #{summer_demand_geb_values.size}"
-    puts "winter_demand_base_values.size: #{winter_demand_base_values.size}"
-    puts "winter_demand_geb_values.size: #{winter_demand_geb_values.size}"
-
     if (shed_start.is_a?Time) && (shed_end.is_a?Time)
       shed_range = [shed_start.strftime("%H:%M"), shed_end.strftime("%H:%M")]
       demand_decrease_shed_period = []
@@ -514,11 +505,6 @@ module OsLib_Reporting
       end
     end
 
-    puts "demand_base_shed_period: #{demand_base_shed_period.inspect}"
-    puts "demand_decrease_shed_period: #{demand_decrease_shed_period.inspect}"
-    puts "demand_base_take_period: #{demand_base_take_period.inspect}"
-    puts "demand_increase_take_period: #{demand_increase_take_period.inspect}"
-
     # table: list all the primary DF metrics
     demand_decrease_primary_metrics_table = {}
     demand_decrease_primary_metrics_table[:title] = 'Demand Decrease (Shed) Primary Metrics'
@@ -569,8 +555,6 @@ module OsLib_Reporting
       end
     end
 
-    puts "demand_decrease_primary_metrics_table[:data]: #{demand_decrease_primary_metrics_table[:data].inspect}"
-
     # plot: event day timestep demand profiles of baseline and GEB measures
     bldg_demand_chart = {}
     bldg_demand_chart[:title] = 'Whole Building Net Electricity Consumption on selected day (W)'
@@ -602,9 +586,6 @@ module OsLib_Reporting
       y: event_day_geb_values
     )
 
-    puts "demand_decrease_primary_metrics_table: #{demand_decrease_primary_metrics_table.inspect}"
-    puts "bldg_demand_chart: #{bldg_demand_chart.inspect}"
-
     @geb_metrics_section[:tables] << demand_decrease_primary_metrics_table
     @geb_metrics_section[:bldg_demand_charts] << bldg_demand_chart
     # @geb_metrics_section[:tables] << demand_increase_primary_metrics_table

data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/LICENSE.md

@@ -0,0 +1,13 @@
+OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+
+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. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
+
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+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.

data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/README.md

@@ -0,0 +1,152 @@
+
+
+###### (Automatically generated documentation)
+
+# Add fan assist night ventilation with hybrid control
+
+## Description
+This measure is modified based on the OS measure "fan_assist_night_ventilation" from "openstudio-ee-gem".  It adds night ventilation that is enabled by opening windows assisted by exhaust fans. Hybrid ventilation  control is added to avoid simultaneous operation of windows and HVAC.
+
+## Modeler Description
+This measure adds a zone ventilation object to each zone with operable windwos. The measure will first  look for a celing opening to find a connection for zone a zone mixing object. If a ceiling isn't found,  then it looks for a wall. The end result is zone ventilation object followed by a path of zone mixing objects.  The exhaust fan consumption is modeled in the zone ventilation object, but no heat is brought in from the fan. 
+ Different from the original 'fan_assist_night_ventilation' measure, this measure can be applied to models  with mechenical systems. HybridVentilationAvailabilityManager is added to airloops and zonal systems to avoid  simultaneous operation of windows and HVAC. The zone ventilation is controlled by a combination of schedule,  indoor and outdoor temperature, and wind speed.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Design night ventilation air change rate defined by ACH-air changes per hour
+
+**Name:** design_night_vent_ach,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Fan Pressure Rise
+
+**Name:** fan_pressure_rise,
+**Type:** Double,
+**Units:** Pa,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Fan Total Efficiency
+
+**Name:** efficiency,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Minimum Indoor Temperature (degC)
+The indoor temperature below which ventilation is shutoff.
+**Name:** min_indoor_temp,
+**Type:** Double,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Maximum Indoor Temperature (degC)
+The indoor temperature above which ventilation is shutoff.
+**Name:** max_indoor_temp,
+**Type:** Double,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Minimum Indoor-Outdoor Temperature Difference (degC)
+This is the temperature difference between the indoor and outdoor air dry-bulb temperatures below which ventilation is shutoff.  For example, a delta temperature of 2 degC means ventilation is available if the outside air temperature is at least 2 degC cooler than the zone air temperature. Values can be negative.
+**Name:** delta_temp,
+**Type:** Double,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Minimum Outdoor Temperature (degC)
+The outdoor temperature below which ventilation is shut off.
+**Name:** min_outdoor_temp,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Maximum Outdoor Temperature (degC)
+The outdoor temperature above which ventilation is shut off.
+**Name:** max_outdoor_temp,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Maximum Wind Speed (m/s)
+This is the wind speed above which ventilation is shut off.  The default values assume windows are closed when wind is above a gentle breeze to avoid blowing around papers in the space.
+**Name:** max_wind_speed,
+**Type:** Double,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Daily Start Time for natural ventilation
+Use 24 hour format (HR:MM)
+**Name:** night_vent_starttime,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Daily End Time for natural ventilation
+Use 24 hour format (HR:MM)
+**Name:** night_vent_endtime,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Start Date for natural ventilation
+In MM-DD format
+**Name:** night_vent_startdate,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### End Date for natural ventilation
+In MM-DD format
+**Name:** night_vent_enddate,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Allow night time ventilation on weekends
+
+**Name:** wknds,
+**Type:** Boolean,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+
+
+
+

data/lib/measures/add_fan_assist_night_ventilation_with_hybrid_control/README.md.erb

@@ -0,0 +1,45 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% if argument[:type] == "Choice" && !argument[:model_dependent]%>
+**Choice Display Names** <%= argument[:choice_display_names] %>
+<% end %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>