honeybee-openstudio 2.37.0 → 2.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55f3b4e41dbed57ccc2aaad7de1254c5a02bd6e4c82c7308e615d9c449326c8
-  data.tar.gz: 4a2078fc0600a51f6441eed73a603b38496e4f4beae780be047f4251c274e880
+  metadata.gz: 29f2ccee97b67e79d4c5ac17749a0e27d3fbce5c39a9bd35b1cc8ede1e4b324b
+  data.tar.gz: 543203bb0e0b04b2e333c5b6cdb4e0d9d9f71dce069cdca49ce885d46eb406e1
 SHA512:
-  metadata.gz: f5f610b0d0f78fec02e2b4c7523678ca3d0b8db36872a5dd8e389dfafe2cc5ced5c7cb2cb022f33a2c062c4b6a21fb1767795688d4c333dd228e1098c446b371
-  data.tar.gz: 947221a88fb38a8ff3ec815c8a6073f09a2e424286ace005dbcf371f6c5c8e9777c829e6eb9a603e71469c25ec53a4846f4848cc3b675b6457ffeada5bf8971c
+  metadata.gz: f774d8538c3a2ef55628adabc6ff8a733113bf2aa8a0584cc63364750d214bb800ae4dcf002c74d0b4260d9e7c921ee42003e4ba09e1c337c2551581aa6fe615
+  data.tar.gz: 5bbe03f646a5e63b058c10a556a0694f1eaf84e74d88921c5c247a62d91a4908435093d22406f73f415f9b282393783f6740cfcc2fda238cf9d80da1eb4330aa

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.37.0'
+  spec.version       = '2.38.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/honeybee/_defaults/model.json

@@ -3,7 +3,7 @@
   "servers": [],
   "info": {
     "description": "Honeybee model schema.",
-    "version": "1.54.0",
+    "version": "1.55.0",
     "title": "Honeybee Model Schema",
     "contact": {
       "name": "Ladybug Tools",
@@ -204,6 +204,11 @@
       "x-displayName": "ElectricEquipmentAbridged",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ElectricEquipmentAbridged\" />\n"
     },
+    {
+      "name": "electricloadcenter_model",
+      "x-displayName": "ElectricLoadCenter",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ElectricLoadCenter\" />\n"
+    },
     {
       "name": "energymaterial_model",
       "x-displayName": "EnergyMaterial",
@@ -484,11 +489,21 @@
       "x-displayName": "ModifierSetAbridged",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModifierSetAbridged\" />\n"
     },
+    {
+      "name": "moduletype_model",
+      "x-displayName": "ModuleType",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ModuleType\" />\n"
+    },
     {
       "name": "moisturediffusionmodel_model",
       "x-displayName": "MoistureDiffusionModel",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/MoistureDiffusionModel\" />\n"
     },
+    {
+      "name": "mountingtype_model",
+      "x-displayName": "MountingType",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/MountingType\" />\n"
+    },
     {
       "name": "nolimit_model",
       "x-displayName": "NoLimit",
@@ -544,6 +559,11 @@
       "x-displayName": "PVAVEquipmentType",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PVAVEquipmentType\" />\n"
     },
+    {
+      "name": "pvproperties_model",
+      "x-displayName": "PVProperties",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/PVProperties\" />\n"
+    },
     {
       "name": "people_model",
       "x-displayName": "People",
@@ -1050,6 +1070,7 @@
         "economizertype_model",
         "electricequipment_model",
         "electricequipmentabridged_model",
+        "electricloadcenter_model",
         "energymaterial_model",
         "energymaterialnomass_model",
         "energymaterialvegetation_model",
@@ -1106,7 +1127,9 @@
         "modelradianceproperties_model",
         "modifierset_model",
         "modifiersetabridged_model",
+        "moduletype_model",
         "moisturediffusionmodel_model",
+        "mountingtype_model",
         "nolimit_model",
         "opaqueconstruction_model",
         "opaqueconstructionabridged_model",
@@ -1125,6 +1148,7 @@
         "ptacequipmenttype_model",
         "pvav_model",
         "pvavequipmenttype_model",
+        "pvproperties_model",
         "radianceshadestateabridged_model",
         "radiancesubfacestateabridged_model",
         "radiant_model",
@@ -1495,6 +1519,104 @@
         },
         "additionalProperties": false
       },
+      "ModuleType": {
+        "title": "ModuleType",
+        "description": "An enumeration.",
+        "enum": [
+          "Standard",
+          "Premium",
+          "ThinFilm"
+        ],
+        "type": "string"
+      },
+      "MountingType": {
+        "title": "MountingType",
+        "description": "An enumeration.",
+        "enum": [
+          "FixedOpenRack",
+          "FixedRoofMounted",
+          "OneAxis",
+          "OneAxisBacktracking",
+          "TwoAxis"
+        ],
+        "type": "string"
+      },
+      "PVProperties": {
+        "title": "PVProperties",
+        "description": "Base class for all objects requiring a valid EnergyPlus identifier.",
+        "type": "object",
+        "properties": {
+          "identifier": {
+            "title": "Identifier",
+            "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
+            "maxLength": 100,
+            "minLength": 1,
+            "pattern": "^[^,;!\\n\\t]+$",
+            "type": "string"
+          },
+          "display_name": {
+            "title": "Display Name",
+            "description": "Display name of the object with no character restrictions.",
+            "type": "string"
+          },
+          "type": {
+            "title": "Type",
+            "default": "PVProperties",
+            "pattern": "^PVProperties$",
+            "type": "string",
+            "readOnly": true
+          },
+          "rated_efficiency": {
+            "title": "Rated Efficiency",
+            "description": "A number between 0 and 1 for the rated nameplate efficiency of the photovoltaic solar cells under standard test conditions (STC). Standard test conditions are 1,000 Watts per square meter solar irradiance, 25 degrees C cell temperature, and ASTM G173-03 standard spectrum. Nameplate efficiencies reported by manufacturers are typically under STC. Standard poly- or mono-crystalline silicon modules tend to have rated efficiencies in the range of 14-17%. Premium high efficiency mono-crystalline silicon modules with anti-reflective coatings can have efficiencies in the range of 18-20%. Thin film photovoltaic modules typically have efficiencies of 11% or less. (Default: 0.15 for standard silicon solar cells).",
+            "default": 0.15,
+            "exclusiveMinimum": 0,
+            "exclusiveMaximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "active_area_fraction": {
+            "title": "Active Area Fraction",
+            "description": "The fraction of the parent Shade geometry that is covered in active solar cells. This fraction includes the difference between the PV panel (aka. PV module) area and the active cells within the panel as well as any losses for how the (typically rectangular) panels can be arranged on the Shade geometry. When the parent Shade geometry represents just the solar panels, this fraction is typically around 0.9 given that the framing elements of the panel reduce the overall active area. (Default: 0.9, assuming parent Shade geometry represents only the PV panel geometry).",
+            "default": 0.9,
+            "exclusiveMinimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "module_type": {
+            "description": "Text to indicate the type of solar module. This is used to determine the temperature coefficients used in the simulation of the photovoltaic modules. When the rated_efficiency is between 12-18%, the Standard type is typically most appropriate. When the rated_efficiency is greater than 18%, the Premium type is likely more appropriate. When the rated_efficiency is less than 12%, this likely refers to a case where the ThinFilm module type is most appropriate.",
+            "default": "Standard",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ModuleType"
+              }
+            ]
+          },
+          "mounting_type": {
+            "description": "Text to indicate the type of mounting and/or tracking used for the photovoltaic array. Note that the OneAxis options have an axis of rotation that is determined by the azimuth of the parent Shade geometry. Also note that, in the case of one or two axis tracking, shadows on the (static) parent Shade geometry still reduce the electrical output, enabling the simulation to account for large context geometry casting shadows on the array. However, the effects of smaller detailed shading may be improperly accounted for and self shading of the dynamic panel geometry is only accounted for via the tracking_ground_coverage_ratio property on this object. FixedOpenRack refers to ground or roof mounting where the air flows freely. FixedRoofMounted refers to mounting flush with the roof with limited air flow. OneAxis refers to a fixed tilt and azimuth, which define an axis of rotation. OneAxisBacktracking is the same as OneAxis but with controls to reduce self-shade at low sun angles. TwoAxis refers to a dynamic tilt and azimuth that track the sun.",
+            "default": "FixedOpenRack",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MountingType"
+              }
+            ]
+          },
+          "system_loss_fraction": {
+            "title": "System Loss Fraction",
+            "description": "A number between 0 and 1 for the fraction of the electricity output lost due to factors other than EPW weather conditions, panel efficiency/type, active area, mounting, and inverter conversion from DC to AC. Factors that should be accounted for in this input include soiling, snow, wiring losses, electrical connection losses, manufacturer defects/tolerances/mismatch in cell characteristics, losses from power grid availability, and losses due to age or light-induced degradation. Losses from these factors tend to be between 10-20% but can vary widely depending on the installation, maintenance and the grid to which the panels are connected..",
+            "default": 0.14,
+            "minimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "identifier"
+        ],
+        "additionalProperties": false
+      },
       "ShadeEnergyPropertiesAbridged": {
         "title": "ShadeEnergyPropertiesAbridged",
         "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -1520,6 +1642,15 @@
             "maxLength": 100,
             "minLength": 1,
             "type": "string"
+          },
+          "pv_properties": {
+            "title": "Pv Properties",
+            "description": "An optional PVProperties object to specify photovoltaic behavior of the Shade. If None, the Shade will have no Photovoltaic properties. Note that the normal of the Shade is important in determining the performance of the shade as a PV geometry.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/PVProperties"
+              }
+            ]
           }
         },
         "additionalProperties": false
@@ -10841,6 +10972,38 @@
         },
         "additionalProperties": false
       },
+      "ElectricLoadCenter": {
+        "title": "ElectricLoadCenter",
+        "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
+        "type": "object",
+        "properties": {
+          "type": {
+            "title": "Type",
+            "default": "ElectricLoadCenter",
+            "pattern": "^ElectricLoadCenter$",
+            "type": "string",
+            "readOnly": true
+          },
+          "inverter_efficiency": {
+            "title": "Inverter Efficiency",
+            "description": "A number between 0 and 1 for the load center inverter nominal rated DC-to-AC conversion efficiency. An inverter converts DC power, such as that output by photovoltaic panels, to AC power, such as that distributed by the electrical grid and is available from standard electrical outlets. Inverter efficiency is defined as the inverter rated AC power output divided by its rated DC power output.",
+            "default": 0.96,
+            "exclusiveMinimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "inverter_dc_to_ac_size_ratio": {
+            "title": "Inverter Dc To Ac Size Ratio",
+            "description": "A positive number (typically greater than 1) for the ratio of the inverter DC rated size to its AC rated size. Typically, inverters are not sized to convert the full DC output under standard test conditions (STC) as such conditions rarely occur in reality and therefore unnecessarily add to the size/cost of the inverter. For a system with a high DC to AC size ratio, during times when the DC power output exceeds the inverter rated DC input size, the inverter limits the power output by increasing the DC operating voltage, which moves the arrays operating point down its current-voltage (I-V) curve. In EnergyPlus, this is accomplished by simply limiting the system output to the AC size as dictated by the ratio. The default value of 1.1 is reasonable for most systems. A typical range is 1.1 to 1.25, although some large-scale systems have ratios of as high as 1.5. The optimal value depends on the system location, array orientation, and module cost.",
+            "default": 1.1,
+            "exclusiveMinimum": 0,
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "additionalProperties": false
+      },
       "ModelEnergyProperties": {
         "title": "ModelEnergyProperties",
         "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
@@ -11521,6 +11684,15 @@
                 "$ref": "#/components/schemas/VentilationSimulationControl"
               }
             ]
+          },
+          "electric_load_center": {
+            "title": "Electric Load Center",
+            "description": "An optional parameter object that defines the properties of the model electric loads center that manages on site electricity generation and conversion.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ElectricLoadCenter"
+              }
+            ]
           }
         },
         "additionalProperties": false
@@ -14623,7 +14795,7 @@
           "version": {
             "title": "Version",
             "description": "Text string for the current version of the schema.",
-            "default": "1.54.0",
+            "default": "1.55.0",
             "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
             "type": "string",
             "readOnly": true

data/lib/honeybee/generator/loadcenter.rb

@@ -0,0 +1,42 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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 'honeybee/model_object'
+
+module Honeybee
+  class ElectricLoadCenter < ModelObject
+
+    def defaults
+      @@schema[:components][:schemas][:ElectricLoadCenter][:properties]
+    end
+
+  end #ElectricLoadCenter
+end #Honeybee

data/lib/honeybee/generator/pv.rb

@@ -0,0 +1,42 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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 'honeybee/model_object'
+
+module Honeybee
+  class PVProperties < ModelObject
+
+    def defaults
+      @@schema[:components][:schemas][:PVProperties][:properties]
+    end
+
+  end #PVProperties
+end #Honeybee

data/lib/honeybee.rb

@@ -96,6 +96,10 @@ require 'honeybee/ventcool/opening'
 require 'honeybee/ventcool/simulation'
 require 'honeybee/internalmass'
 
+# import the generator objects
+require 'honeybee/generator/loadcenter'
+require 'honeybee/generator/pv'
+
 # import the simulation objects
 require 'honeybee/simulation/design_day'
 require 'honeybee/simulation/parameter_model'

data/lib/to_openstudio/generator/loadcenter.rb

@@ -0,0 +1,71 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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 'honeybee/generator/loadcenter'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ElectricLoadCenter
+
+    def to_openstudio(openstudio_model, generator_objects)
+      # create the ElectricLoadCenter:Distribution specification
+      load_center = OpenStudio::Model::ElectricLoadCenterDistribution.new(openstudio_model)
+      load_center.setName('Model Load Center Distribution')
+
+      # add the generators to the specification
+      generator_objects.each do |gen_obj|
+        load_center.addGenerator(gen_obj)
+      end
+
+      # assign the major properties to the load center
+      load_center.setGeneratorOperationSchemeType('Baseload')
+      load_center.setElectricalBussType('DirectCurrentWithInverter')
+
+      # create the inverter and assign it
+      inverter = OpenStudio::Model::ElectricLoadCenterInverterPVWatts.new(openstudio_model)
+      if @hash[:inverter_dc_to_ac_size_ratio]
+        inverter.setDCToACSizeRatio(@hash[:inverter_dc_to_ac_size_ratio])
+      else
+        inverter.setDCToACSizeRatio(defaults[:inverter_dc_to_ac_size_ratio][:default])
+      end
+      if @hash[:inverter_efficiency]
+        inverter.setInverterEfficiency(@hash[:inverter_efficiency])
+      else
+        inverter.setInverterEfficiency(defaults[:inverter_efficiency][:default])
+      end
+      load_center.setInverter(inverter)
+
+      load_center
+    end
+
+  end #ElectricLoadCenter
+end #Honeybee

data/lib/to_openstudio/generator/pv.rb

@@ -0,0 +1,86 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. 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.
+#
+# 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 'honeybee/generator/pv'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class PVProperties
+
+    def to_openstudio(openstudio_model, parent)
+      # calculate the DC system size from the efficiency and the parent area
+      rated_watts = defaults[:rated_efficiency][:default] * 1000
+      if @hash[:rated_efficiency]
+        rated_watts = @hash[:rated_efficiency]  * 1000
+      end
+      active_fraction = defaults[:active_area_fraction][:default]
+      if @hash[:active_area_fraction]
+        active_fraction = @hash[:active_area_fraction]
+      end
+      sys_cap = parent.netArea * active_fraction * rated_watts
+      sys_cap = sys_cap.round
+
+      # create the PVWatts generator and set identifier
+      os_gen = OpenStudio::Model::GeneratorPVWatts.new(openstudio_model, parent, sys_cap)
+      os_gen.setName(@hash[:identifier] + '..' + parent.name.get)
+
+      # assign the module type
+      if @hash[:module_type]
+        os_gen.setModuleType(@hash[:module_type])
+      else
+        os_gen.setModuleType(defaults[:module_type][:default])
+      end
+
+      # assign the mounting type
+      if @hash[:mounting_type]
+        os_gen.setArrayType(@hash[:mounting_type])
+      else
+        os_gen.setArrayType(defaults[:mounting_type][:default])
+      end
+
+      # assign the system loss fraction
+      if @hash[:system_loss_fraction]
+        os_gen.setSystemLosses(@hash[:system_loss_fraction])
+      else
+        os_gen.setSystemLosses(defaults[:system_loss_fraction][:default])
+      end
+
+      # assign the tracking ground coverage ratio
+      if @hash[:tracking_ground_coverage_ratio]
+        os_gen.setGroundCoverageRatio(@hash[:tracking_ground_coverage_ratio])
+      end
+
+      os_gen
+    end
+
+  end #PVProperties
+end #Honeybee

data/lib/to_openstudio/geometry/shade.rb

@@ -82,6 +82,13 @@ module Honeybee
             os_shading_surface.setTransmittanceSchedule(os_schedule)
           end
         end
+
+        # create PV objects if there are properties
+        if @hash[:properties][:energy][:pv_properties]
+          gen_obj = PVProperties.new(@hash[:properties][:energy][:pv_properties])
+          os_gen_obj = gen_obj.to_openstudio(openstudio_model, os_shading_surface)
+          $generators << os_gen_obj
+        end
       end
 
       os_shading_surface

data/lib/to_openstudio/model.rb

@@ -133,6 +133,7 @@ module Honeybee
       $shw_for_plant = nil  # track whether a hot water plant is needed
       $detailed_hvac_hash = Hash.new  # track the detailed HVAC systems that have been assigned
       $ironbug_exe = nil  # ironbug executable; will be overwritten by any detailed HVACs
+      $generators = []  # track the generator objects in the model
 
       # create all of the non-geometric model elements
       if @hash[:properties].key?(:energy)
@@ -217,6 +218,20 @@ module Honeybee
       create_orphaned_apertures
       create_orphaned_doors
       create_shade_meshes
+
+      unless $generators.empty?
+        if log_report
+          puts 'Translating Electricity Generators'
+        end
+        if @hash[:properties][:energy][:electric_load_center]
+          load_center_object = ElectricLoadCenter.new(
+            @hash[:properties][:energy][:electric_load_center])
+        else
+          empty_hash = Hash.new
+          load_center_object = ElectricLoadCenter.new(empty_hash)
+        end
+        load_center_object.to_openstudio(@openstudio_model, $generators)
+      end
     end
 
     def create_materials(material_dicts, check_existing=false)

data/lib/to_openstudio.rb

@@ -96,6 +96,10 @@ require 'to_openstudio/ventcool/opening'
 require 'to_openstudio/ventcool/simulation'
 require 'to_openstudio/internalmass'
 
+# import the generator objects
+require 'to_openstudio/generator/loadcenter'
+require 'to_openstudio/generator/pv'
+
 # extend the simulation objects
 require 'to_openstudio/simulation/design_day'
 require 'to_openstudio/simulation/parameter_model'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.37.0
+  version: 2.38.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -133,6 +133,8 @@ files:
 - lib/honeybee/construction/windowshade.rb
 - lib/honeybee/construction_set.rb
 - lib/honeybee/extension.rb
+- lib/honeybee/generator/loadcenter.rb
+- lib/honeybee/generator/pv.rb
 - lib/honeybee/geometry/aperture.rb
 - lib/honeybee/geometry/door.rb
 - lib/honeybee/geometry/face.rb
@@ -226,6 +228,8 @@ files:
 - lib/to_openstudio/construction/window.rb
 - lib/to_openstudio/construction/windowshade.rb
 - lib/to_openstudio/construction_set.rb
+- lib/to_openstudio/generator/loadcenter.rb
+- lib/to_openstudio/generator/pv.rb
 - lib/to_openstudio/geometry/aperture.rb
 - lib/to_openstudio/geometry/door.rb
 - lib/to_openstudio/geometry/face.rb