RubyGems - openstudio-common-measures - Versions diffs - 0.2.0 → 0.2.1 - Mend

openstudio-common-measures 0.2.0 → 0.2.1

Files changed (165) hide show

data/lib/measures/generic_qaqc/resources/report.html.erb CHANGED

@@ -38,6 +38,7 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>

data/lib/measures/hvac_psychrometric_chart/README.md CHANGED

@@ -2,16 +2,16 @@
 ###### (Automatically generated documentation)
-#
+# HVAC Psychrometric Chart
 ## Description
+A psychrometric chart shows the relationship between air temperature and humidity conditions.
 ## Modeler Description
+WARNING: the report takes a long time to render (can be several minutes!) in the OpenStudio App.  Open it in a web browser if this is too slow for you. Creates a psychrometric chart in SI units that shows the air conditions at each node on the supply side of the selected air loop.  These conditions are obtained by requesting hourly temperature and humidity for these specific nodes.
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 ## Taxonomy
@@ -19,8 +19,14 @@ ModelMeasure
 ## Arguments
+### Air Loop Name
+The name of an Air Loop to create a psychrometric chart for.  Case sensitive.
+**Name:** air_loop_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
-This measure does not have any user arguments

data/lib/measures/hvac_psychrometric_chart/measure.rb CHANGED

@@ -56,7 +56,7 @@ class HVACPsychrometricChart < OpenStudio::Measure::ReportingMeasure
   end
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
     # make an argument for air loop

data/lib/measures/hvac_psychrometric_chart/measure.xml CHANGED

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>hvac_psychrometric_chart</name>
   <uid>97213780-0727-4462-8ec0-9a6c3e475cd6</uid>
-  <version_id>e7f1939b-2224-4ec4-a64a-16ad3d261f3c</version_id>
-  <version_modified>20200509T041912Z</version_modified>
+  <version_id>15fef178-c6a4-4c51-a011-61785817b924</version_id>
+  <version_modified>20200623T195835Z</version_modified>
   <xml_checksum>F657B621</xml_checksum>
   <class_name>HVACPsychrometricChart</class_name>
   <display_name>HVAC Psychrometric Chart</display_name>
@@ -16,12 +16,8 @@
       <display_name>Air Loop Name</display_name>
       <description>The name of an Air Loop to create a psychrometric chart for.  Case sensitive.</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value></default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -48,7 +44,7 @@
   </attributes>
   <files>
     <file>
-      <filename>test_model.osm</filename>
+      <filename>model_test.osm</filename>
       <filetype>osm</filetype>
       <usage_type>test</usage_type>
       <checksum>34E3E58A</checksum>
@@ -80,26 +76,25 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>536E0D5E</checksum>
+      <checksum>3E6E7724</checksum>
     </file>
     <file>
-      <filename>hvac_psychrometric_chart_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>201B9AF5</checksum>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>3DE900D7</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>3D5D8BA4</checksum>
+      <checksum>FC1A190D</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <filename>hvac_psychrometric_chart_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>07B326D0</checksum>
     </file>
   </files>
 </measure>
-<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/measures/hvac_psychrometric_chart/resources/report.html.erb CHANGED

@@ -38,6 +38,7 @@
 <!DOCTYPE html>
 <html>
 <head>

data/lib/measures/inject_idf_objects/measure.xml CHANGED

@@ -1,15 +1,16 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>inject_idf_objects</name>
   <uid>f567dfbc-d280-4d68-b061-019ab2630cd0</uid>
-  <version_id>844f4910-d87b-40fb-921f-3e295c6cbf9f</version_id>
-  <version_modified>20200229T024317Z</version_modified>
+  <version_id>50ae3f92-5650-4971-a14e-370c542eb6bf</version_id>
+  <version_modified>20200623T195835Z</version_modified>
   <xml_checksum>A8BAB05F</xml_checksum>
   <class_name>InjectIDFObjects</class_name>
   <display_name> Inject IDF Objects</display_name>
   <description>This measure allows you to inject IDF objects into an OSM generated IDF prior to passing the IDF off to EnergyPlus.</description>
-  <modeler_description>This provides a stepping stone between exporting an IDF from OpenStudio and hand editing the IDF and writing fully functional OpenStudio EnergyPlus measures.&#xd;
-&#xd;
+  <modeler_description>This provides a stepping stone between exporting an IDF from OpenStudio and hand editing the IDF and writing fully functional OpenStudio EnergyPlus measures.
 This measure works for when you just need to add new IDF objects. If you need to interact with or alter IDF objects made by the OpenStudio forward translator, you will want to write an EnergyPlus measure wtih more use-case specific logic.</modeler_description>
   <arguments>
     <argument>
@@ -21,8 +22,8 @@ This measure works for when you just need to add new IDF objects. If you need to
       <model_dependent>false</model_dependent>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Whole Building.Space Types</tag>
   </tags>
@@ -72,28 +73,11 @@ This measure works for when you just need to add new IDF objects. If you need to
       <checksum>F90DD242</checksum>
     </file>
     <file>
-      <filename>test.osw</filename>
+      <filename>model_test.osw</filename>
       <filetype>osw</filetype>
       <usage_type>test</usage_type>
       <checksum>F5FABCCF</checksum>
     </file>
-    <file>
-      <filename>measure_Test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>617BF7D2</checksum>
-    </file>
-    <file>
-      <version>
-        <software_program>OpenStudio</software_program>
-        <identifier>2.0.0</identifier>
-        <min_compatible>2.0.0</min_compatible>
-      </version>
-      <filename>measure.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>script</usage_type>
-      <checksum>7F05D1DE</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -112,5 +96,22 @@ This measure works for when you just need to add new IDF objects. If you need to
       <usage_type>readme</usage_type>
       <checksum>3D0882F2</checksum>
     </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.0.0</identifier>
+        <min_compatible>2.0.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>83CDE9EB</checksum>
+    </file>
+    <file>
+      <filename>measure_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>B8EDD274</checksum>
+    </file>
   </files>
 </measure>

data/lib/measures/openstudio_results/README.md CHANGED

@@ -2,16 +2,16 @@
 ###### (Automatically generated documentation)
-#
+# OpenStudio Results
 ## Description
+This measure creates high level tables and charts pulling both from model inputs and EnergyPlus results. It has building level information as well as detail on space types, thermal zones, HVAC systems, envelope characteristics, and economics. Click the heading above a chart to view a table of the chart data.
 ## Modeler Description
+For the most part consumption data comes from the tabular EnergyPlus results, however there are a few requests added for time series results. Space type and loop details come from the OpenStudio model. The code for this is modular, making it easy to use as a template for your own custom reports. The structure of the report uses bootstrap, and the graphs use dimple js. The new measure warning section will show warnings generated by upstream measures. It will not show forward translation warnings, EnergyPlus warnings, or warnings that might be reported by this measure.
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 ## Taxonomy
@@ -19,9 +19,199 @@ ModelMeasure
 ## Arguments
+### Which Unit System do you want to use?
+**Name:** units,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Model Summary
+**Name:** building_summary_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Annual Overview
+**Name:** annual_overview_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Monthly Overview
+**Name:** monthly_overview_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Utility Bills/Rates
+**Name:** utility_bills_rates_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Envelope Summary
+**Name:** envelope_section_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Space Type Breakdown
+**Name:** space_type_breakdown_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Space Type Summary
+**Name:** space_type_details_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Interior Lighting Summary
+**Name:** interior_lighting_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Plug Loads Summary
+**Name:** plug_loads_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Exterior Lighting
+**Name:** exterior_light_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Water Use Equipment
+**Name:** water_use_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### HVAC Load Profiles
+**Name:** hvac_load_profile,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Zone Conditions
+**Name:** zone_condition_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Zone Overview
+**Name:** zone_summary_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Zone Equipment Detail
+**Name:** zone_equipment_detail_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Air Loops Detail
+**Name:** air_loops_detail_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Plant Loops Detail
+**Name:** plant_loops_detail_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Outdoor Air
+**Name:** outdoor_air_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Cash Flow
+**Name:** cost_summary_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Site and Source Summary
+**Name:** source_energy_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Schedule Overview
+**Name:** schedules_overview_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Measure Warnings
+**Name:** measure_warning_section,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+### Report monthly fuel and enduse breakdown to registerValue
+This argument does not effect HTML file, instead it makes data from individal cells of monthly tables avaiable for machine readable values in the resulting OpenStudio Workflow file.
+**Name:** reg_monthly_details,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
-This measure does not have any user arguments

data/lib/measures/openstudio_results/measure.rb CHANGED

@@ -58,7 +58,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
   # human readable description of modeling approach
   def modeler_description
-    'For the most part consumption data comes from the tabular EnergyPlus results, however there are a few requests added for time series results. Space type and loop details come from the OpenStudio model. The code for this is modular, making it easy to use as a template for your own custom reports. The structure of the report uses bootstrap, and the graphs use dimple js.'
+    'For the most part consumption data comes from the tabular EnergyPlus results, however there are a few requests added for time series results. Space type and loop details come from the OpenStudio model. The code for this is modular, making it easy to use as a template for your own custom reports. The structure of the report uses bootstrap, and the graphs use dimple js. The new measure warning section will show warnings generated by upstream measures. It will not show forward translation warnings, EnergyPlus warnings, or warnings that might be reported by this measure.'
   end
   def possible_sections
@@ -125,7 +125,7 @@ class OpenStudioResults < OpenStudio::Measure::ReportingMeasure
   end
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
     chs = OpenStudio::StringVector.new