honeybee-openstudio 2.0.0 → 2.0.1

data/lib/from_honeybee/_openapi/simulation-parameter.json

@@ -3,7 +3,7 @@
   "servers": [],
   "info": {
     "description": "This is the documentation for Honeybee energy simulation parameter schema.",
-    "version": "1.27.1",
+    "version": "0.0.1",
     "title": "Honeybee Energy Simulation Parameter Schema",
     "contact": {
       "name": "Ladybug Tools",
@@ -44,6 +44,11 @@
       "x-displayName": "DesignDay",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDay\" />\n"
     },
+    {
+      "name": "designdaytypes_model",
+      "x-displayName": "DesignDayTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDayTypes\" />\n"
+    },
     {
       "name": "drybulbcondition_model",
       "x-displayName": "DryBulbCondition",
@@ -54,16 +59,41 @@
       "x-displayName": "HumidityCondition",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityCondition\" />\n"
     },
+    {
+      "name": "humiditytypes_model",
+      "x-displayName": "HumidityTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityTypes\" />\n"
+    },
     {
       "name": "runperiod_model",
       "x-displayName": "RunPeriod",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunPeriod\" />\n"
     },
+    {
+      "name": "daysofweek_model",
+      "x-displayName": "DaysOfWeek",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DaysOfWeek\" />\n"
+    },
     {
       "name": "shadowcalculation_model",
       "x-displayName": "ShadowCalculation",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadowCalculation\" />\n"
     },
+    {
+      "name": "solardistribution_model",
+      "x-displayName": "SolarDistribution",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SolarDistribution\" />\n"
+    },
+    {
+      "name": "calculationmethod_model",
+      "x-displayName": "CalculationMethod",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationMethod\" />\n"
+    },
+    {
+      "name": "calculationupdatemethod_model",
+      "x-displayName": "CalculationUpdateMethod",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationUpdateMethod\" />\n"
+    },
     {
       "name": "simulationcontrol_model",
       "x-displayName": "SimulationControl",
@@ -74,11 +104,21 @@
       "x-displayName": "SimulationOutput",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationOutput\" />\n"
     },
+    {
+      "name": "reportingfrequency_model",
+      "x-displayName": "ReportingFrequency",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ReportingFrequency\" />\n"
+    },
     {
       "name": "simulationparameter_model",
       "x-displayName": "SimulationParameter",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationParameter\" />\n"
     },
+    {
+      "name": "terriantypes_model",
+      "x-displayName": "TerrianTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/TerrianTypes\" />\n"
+    },
     {
       "name": "sizingparameter_model",
       "x-displayName": "SizingParameter",
@@ -96,16 +136,24 @@
       "tags": [
         "ashraeclearsky_model",
         "ashraetau_model",
+        "calculationmethod_model",
+        "calculationupdatemethod_model",
         "daylightsavingtime_model",
+        "daysofweek_model",
         "designday_model",
+        "designdaytypes_model",
         "drybulbcondition_model",
         "humiditycondition_model",
+        "humiditytypes_model",
+        "reportingfrequency_model",
         "runperiod_model",
         "shadowcalculation_model",
         "simulationcontrol_model",
         "simulationoutput_model",
         "simulationparameter_model",
         "sizingparameter_model",
+        "solardistribution_model",
+        "terriantypes_model",
         "windcondition_model"
       ]
     }
@@ -126,15 +174,13 @@
             "readOnly": true
           },
           "reporting_frequency": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ReportingFrequency"
+              }
+            ],
             "title": "Reporting Frequency",
             "default": "Hourly",
-            "enum": [
-              "Timestep",
-              "Hourly",
-              "Daily",
-              "Monthly",
-              "Annual"
-            ],
             "type": "string"
           },
           "include_sqlite": {
@@ -146,7 +192,7 @@
           "include_html": {
             "title": "Include Html",
             "description": "Boolean to note whether an HTML report should be requested from the simulation.",
-            "default": false,
+            "default": true,
             "type": "boolean"
           },
           "outputs": {
@@ -256,18 +302,14 @@
             "maxItems": 2
           },
           "start_day_of_week": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/DaysOfWeek"
+              }
+            ],
             "title": "Start Day Of Week",
             "description": "Text for the day of the week on which the simulation starts.",
             "default": "Sunday",
-            "enum": [
-              "Sunday",
-              "Monday",
-              "Tuesday",
-              "Wednesday",
-              "Thursday",
-              "Friday",
-              "Saturday"
-            ],
             "type": "string"
           },
           "holidays": {
@@ -362,34 +404,45 @@
             "readOnly": true
           },
           "solar_distribution": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/SolarDistribution"
+              }
+            ],
             "title": "Solar Distribution",
             "default": "FullExteriorWithReflections",
-            "enum": [
-              "MinimalShadowing",
-              "FullExterior",
-              "FullInteriorAndExterior",
-              "FullExteriorWithReflections",
-              "FullInteriorAndExteriorWithReflections"
+            "type": "string"
+          },
+          "calculation_method": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/CalculationMethod"
+              }
             ],
+            "title": "Calculation Method",
+            "description": "Text noting whether CPU-based polygon clipping method orGPU-based pixel counting method should be used. For low numbers of shadingsurfaces (less than ~200), PolygonClipping requires less runtime thanPixelCounting. However, PixelCounting runtime scales significantlybetter at higher numbers of shading surfaces. PixelCounting also hasno limitations related to zone concavity when used with any\u201cFullInterior\u201d solar distribution options.",
+            "default": "PolygonClipping",
+            "type": "string"
+          },
+          "calculation_update_method": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/CalculationUpdateMethod"
+              }
+            ],
+            "title": "Calculation Update Method",
+            "description": "Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation.",
+            "default": "Periodic",
             "type": "string"
           },
           "calculation_frequency": {
             "title": "Calculation Frequency",
-            "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the AverageOverDaysInFrequency calculation_method is used.",
+            "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the Periodic calculation_method is used.",
             "default": 30,
             "minimum": 1,
             "type": "integer",
             "format": "int32"
           },
-          "calculation_method": {
-            "title": "Calculation Method",
-            "default": "AverageOverDaysInFrequency",
-            "enum": [
-              "AverageOverDaysInFrequency",
-              "TimestepFrequency"
-            ],
-            "type": "string"
-          },
           "maximum_figures": {
             "title": "Maximum Figures",
             "description": "Number of allowable figures in shadow overlap calculations.",
@@ -441,13 +494,12 @@
         "type": "object",
         "properties": {
           "humidity_type": {
-            "title": "Humidity Type",
-            "enum": [
-              "Wetbulb",
-              "Dewpoint",
-              "HumidityRatio",
-              "Enthalpy"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/HumidityTypes"
+              }
             ],
+            "title": "Humidity Type",
             "type": "string"
           },
           "humidity_value": {
@@ -544,7 +596,7 @@
           },
           "clearness": {
             "title": "Clearness",
-            "description": "Value between 0 and 1.2 that will get multiplied by the irradinace to correct for factors like elevation above sea level.",
+            "description": "Value between 0 and 1.2 that will get multiplied by the irradiance to correct for factors like elevation above sea level.",
             "minimum": 0,
             "maximum": 1.2,
             "type": "number",
@@ -636,20 +688,12 @@
             "type": "string"
           },
           "day_type": {
-            "title": "Day Type",
-            "enum": [
-              "SummerDesignDay",
-              "WinterDesignDay",
-              "Sunday",
-              "Monday",
-              "Tuesday",
-              "Wednesday",
-              "Thursday",
-              "Friday",
-              "Holiday",
-              "CustomDay1",
-              "CustomDay2"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/DesignDayTypes"
+              }
             ],
+            "title": "Day Type",
             "type": "string"
           },
           "dry_bulb_condition": {
@@ -823,20 +867,117 @@
             "format": "double"
           },
           "terrain_type": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TerrianTypes"
+              }
+            ],
             "title": "Terrain Type",
             "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
             "default": "City",
-            "enum": [
-              "Ocean",
-              "Country",
-              "Suburbs",
-              "Urban",
-              "City"
-            ],
             "type": "string"
           }
         },
         "additionalProperties": false
+      },
+      "DesignDayTypes": {
+        "title": "Day Type",
+        "enum": [
+          "SummerDesignDay",
+          "WinterDesignDay",
+          "Sunday",
+          "Monday",
+          "Tuesday",
+          "Wednesday",
+          "Thursday",
+          "Friday",
+          "Holiday",
+          "CustomDay1",
+          "CustomDay2"
+        ],
+        "type": "string"
+      },
+      "HumidityTypes": {
+        "title": "Humidity Type",
+        "enum": [
+          "Wetbulb",
+          "Dewpoint",
+          "HumidityRatio",
+          "Enthalpy"
+        ],
+        "type": "string"
+      },
+      "DaysOfWeek": {
+        "title": "Start Day Of Week",
+        "description": "Text for the day of the week on which the simulation starts.",
+        "default": "Sunday",
+        "enum": [
+          "Sunday",
+          "Monday",
+          "Tuesday",
+          "Wednesday",
+          "Thursday",
+          "Friday",
+          "Saturday"
+        ],
+        "type": "string"
+      },
+      "SolarDistribution": {
+        "title": "Solar Distribution",
+        "default": "FullExteriorWithReflections",
+        "enum": [
+          "MinimalShadowing",
+          "FullExterior",
+          "FullInteriorAndExterior",
+          "FullExteriorWithReflections",
+          "FullInteriorAndExteriorWithReflections"
+        ],
+        "type": "string"
+      },
+      "CalculationMethod": {
+        "title": "Calculation Method",
+        "description": "Text noting whether CPU-based polygon clipping method orGPU-based pixel counting method should be used. For low numbers of shadingsurfaces (less than ~200), PolygonClipping requires less runtime thanPixelCounting. However, PixelCounting runtime scales significantlybetter at higher numbers of shading surfaces. PixelCounting also hasno limitations related to zone concavity when used with any\u201cFullInterior\u201d solar distribution options.",
+        "default": "PolygonClipping",
+        "enum": [
+          "PolygonClipping",
+          "PixelCounting"
+        ],
+        "type": "string"
+      },
+      "CalculationUpdateMethod": {
+        "title": "Calculation Update Method",
+        "description": "Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation.",
+        "default": "Periodic",
+        "enum": [
+          "Periodic",
+          "Timestep"
+        ],
+        "type": "string"
+      },
+      "ReportingFrequency": {
+        "title": "Reporting Frequency",
+        "default": "Hourly",
+        "enum": [
+          "Timestep",
+          "Hourly",
+          "Daily",
+          "Monthly",
+          "Annual"
+        ],
+        "type": "string"
+      },
+      "TerrianTypes": {
+        "title": "Terrain Type",
+        "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
+        "default": "City",
+        "enum": [
+          "Ocean",
+          "Country",
+          "Suburbs",
+          "Urban",
+          "City"
+        ],
+        "type": "string"
       }
     }
   }

data/lib/from_honeybee/simulation/parameter.rb

@@ -147,6 +147,18 @@ module FromHoneybee
 
       # set defaults for the Model's ShadowCalculation object
       os_shadow_calc = @openstudio_model.getShadowCalculation
+      begin
+        os_shadow_calc.setShadingCalculationMethod(
+          shdw_defaults[:calculation_method][:default])
+      rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+        os_shadow_calc.setCalculationMethod(
+          shdw_defaults[:calculation_method][:default])
+      end
+      begin
+        os_shadow_calc.setShadingCalculationUpdateFrequencyMethod(
+          shdw_defaults[:calculation_update_method][:default])
+      rescue  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+      end
       begin
         os_shadow_calc.setShadingCalculationUpdateFrequency(
           shdw_defaults[:calculation_frequency][:default])
@@ -156,16 +168,25 @@ module FromHoneybee
       end
       os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(
         shdw_defaults[:maximum_figures][:default])
-      begin
-        os_shadow_calc.setShadingCalculationMethod(
-          shdw_defaults[:calculation_method][:default])
-      rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
-        os_shadow_calc.setCalculationMethod(
-          shdw_defaults[:calculation_method][:default])
-      end
 
       # override any ShadowCalculation defaults with lodaded JSON
       if @hash[:shadow_calculation]
+        if @hash[:shadow_calculation][:calculation_method]
+          begin
+            os_shadow_calc.setShadingCalculationMethod(
+              @hash[:shadow_calculation][:calculation_method])
+          rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+            os_shadow_calc.setCalculationMethod(
+              @hash[:shadow_calculation][:calculation_method])
+          end
+        end
+        if @hash[:shadow_calculation][:calculation_update_method]
+          begin
+            os_shadow_calc.setShadingCalculationUpdateFrequencyMethod(
+              @hash[:shadow_calculation][:calculation_update_method])
+          rescue  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
+          end
+        end
         if @hash[:shadow_calculation][:calculation_frequency]
           begin
             os_shadow_calc.setShadingCalculationUpdateFrequency(
@@ -176,19 +197,12 @@ module FromHoneybee
           end
         end
         if @hash[:shadow_calculation][:maximum_figures]
-          os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(@hash[:shadow_calculation][:maximum_figures])
-        end
-        if @hash[:shadow_calculation][:calculation_method]
-          begin
-            os_shadow_calc.setShadingCalculationMethod(
-              @hash[:shadow_calculation][:calculation_method])
-          rescue NoMethodError  # REMOVE: Once the upgrade to OpenStudio 3.0 is official
-            os_shadow_calc.setCalculationMethod(
-              @hash[:shadow_calculation][:calculation_method])
-          end
+          os_shadow_calc.setMaximumFiguresInShadowOverlapCalculations(
+            @hash[:shadow_calculation][:maximum_figures])
         end
         if @hash[:shadow_calculation][:solar_distribution]
-          os_sim_control.setSolarDistribution(@hash[:shadow_calculation][:solar_distribution])
+          os_sim_control.setSolarDistribution(
+            @hash[:shadow_calculation][:solar_distribution])
         end
       end