openstudio-common-measures 0.6.1 → 0.7.0

data/lib/measures/envelope_and_internal_load_breakdown/README.md

@@ -25,3 +25,34 @@ ReportingMeasure
 This measure does not have any user arguments
 
 
+
+
+###### (Manually generated documentation)
+## Report Screenshots
+
+* Colors of envelope components match default model rendering by surface type. 
+* Colors for equipment and lights use colors similar to OpenStudio Results. 
+* Click the blue headings above plots to expand source table. 
+
+#### Heat Gains Summary
+*Annual pie chart and monthly stacked bar chart by component.*
+
+![Heat Gains Summary](./docs/htg_gain_summary.png?raw=true)
+
+#### Heat Loss Summary
+*Annual pie chart and monthly stacked bar chart by component.*
+
+![Heat Loss Summary](./docs/htg_loss_summary.png?raw=true)
+
+#### Heat Gains By Month Detailed
+*Each component type has a table with each contributing object listed by month. There are annual totals for each component, and there is a monthly total with all components of that type aggregated*
+
+![Heat Gains By Month Detailed - a](./docs/htg_gain_detailed_a.png?raw=true)
+
+*Each sub-surface and surface with an outdoor or ground boundary boundary condition is listed. At the end of the surface type a row subtotals the heat gains by outdoor walls, outdoor roofs, and ground boundary surfaces.*
+![Heat Gains By Month Detailed - b](./docs/htg_gain_detailed_b.png?raw=true)
+
+#### Heat Losses By Month Detailed
+*Each component type has a table with each contributing object listed by month. There are annual totals for each component, and there is a monthly total with all components of that type aggregated*
+
+![Heat Losses By Month Detailed](./docs/htg_loss_detailed.png?raw=true)

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

@@ -39,4 +39,34 @@
 <% output_names << output[:display_name] %>
 <% end %>
 <%= output_names.join(", ") %>
-<% end %>
+<% end %>
+
+###### (Manually generated documentation)
+## Report Screenshots
+
+* Colors of envelope components match default model rendering by surface type. 
+* Colors for equipment and lights use colors similar to OpenStudio Results. 
+* Click the blue headings above plots to expand source table. 
+
+#### Heat Gains Summary
+*Annual pie chart and monthly stacked bar chart by component.*
+
+![Heat Gains Summary](./docs/htg_gain_summary.png?raw=true)
+
+#### Heat Loss Summary
+*Annual pie chart and monthly stacked bar chart by component.*
+
+![Heat Loss Summary](./docs/htg_loss_summary.png?raw=true)
+
+#### Heat Gains By Month Detailed
+*Each component type has a table with each contributing object listed by month. There are annual totals for each component, and there is a monthly total with all components of that type aggregated*
+
+![Heat Gains By Month Detailed - a](./docs/htg_gain_detailed_a.png?raw=true)
+
+*Each sub-surface and surface with an outdoor or ground boundary boundary condition is listed. At the end of the surface type a row subtotals the heat gains by outdoor walls, outdoor roofs, and ground boundary surfaces.*
+![Heat Gains By Month Detailed - b](./docs/htg_gain_detailed_b.png?raw=true)
+
+#### Heat Losses By Month Detailed
+*Each component type has a table with each contributing object listed by month. There are annual totals for each component, and there is a monthly total with all components of that type aggregated*
+
+![Heat Losses By Month Detailed](./docs/htg_loss_detailed.png?raw=true)

data/lib/measures/envelope_and_internal_load_breakdown/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/envelope_and_internal_load_breakdown/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>envelope_and_internal_load_breakdown</name>
   <uid>8f0e1fbb-8bc6-46e5-b6e4-db59177e2c02</uid>
-  <version_id>2ff096f8-c72d-444a-a56e-f0633fba2013</version_id>
-  <version_modified>20220622T165903Z</version_modified>
+  <version_id>094a25e3-d116-401e-8cdb-ae076a79079a</version_id>
+  <version_modified>20221115T224203Z</version_modified>
   <xml_checksum>69BA4D91</xml_checksum>
   <class_name>EnvelopeAndInternalLoadBreakdown</class_name>
   <display_name>Envelope and Internal Load Breakdown</display_name>
@@ -94,29 +94,59 @@
       <usage_type>test</usage_type>
       <checksum>CA6A593D</checksum>
     </file>
+    <file>
+      <filename>htg_gain_detailed_a.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>68441A05</checksum>
+    </file>
+    <file>
+      <filename>htg_gain_detailed_b.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>3D630E8A</checksum>
+    </file>
+    <file>
+      <filename>htg_gain_summary.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>E8E7FBC8</checksum>
+    </file>
+    <file>
+      <filename>htg_loss_summary.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>69DDA02E</checksum>
+    </file>
+    <file>
+      <filename>htg_loss_detailed.png</filename>
+      <filetype>png</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>6E4E8FE2</checksum>
+    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
       <usage_type>readmeerb</usage_type>
-      <checksum>703C9964</checksum>
+      <checksum>1223C55C</checksum>
     </file>
     <file>
       <filename>os_lib_reporting_envelope_and_internal_loads_breakdown.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>AB999863</checksum>
+      <checksum>471E57CB</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>A21A3ED2</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <filename>EnvelopeAndInternalLoadBreakdown_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>092C8D11</checksum>
+      <checksum>C9C97ADF</checksum>
     </file>
     <file>
       <version>
@@ -127,19 +157,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>01602504</checksum>
+      <checksum>4B3CF7A8</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>F66552F1</checksum>
+      <checksum>7D00FFF0</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>6F54D1FE</checksum>
+      <checksum>0C9A88EB</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/envelope_and_internal_load_breakdown/resources/os_lib_reporting_envelope_and_internal_loads_breakdown.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/envelope_and_internal_load_breakdown/resources/report.html.erb

@@ -46,6 +46,10 @@
 
 
 
+
+
+
+
 <!DOCTYPE html>
 <html lang="en">
 <head>

data/lib/measures/example_report/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/example_report/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/example_report/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>example_report</name>
   <uid>174a6f71-3e8c-4f99-9e7a-b64f2e7535d4</uid>
-  <version_id>69180469-2020-4295-b159-80a548ad4c5c</version_id>
-  <version_modified>20220622T165857Z</version_modified>
+  <version_id>7a62653c-c1e8-4550-a21f-3655bded5074</version_id>
+  <version_modified>20221115T224157Z</version_modified>
   <xml_checksum>557BF06F</xml_checksum>
   <class_name>ExampleReport</class_name>
   <display_name>Example Report</display_name>
@@ -138,19 +138,19 @@
       <filename>os_lib_reporting_example.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>BA1A3712</checksum>
+      <checksum>79453AA9</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>A21A3ED2</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <filename>ExampleReport_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>9236651D</checksum>
+      <checksum>45DFAE69</checksum>
     </file>
     <file>
       <version>
@@ -161,13 +161,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>F11E0560</checksum>
+      <checksum>04DFD4D1</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>1C5120F7</checksum>
+      <checksum>71EF0A45</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/example_report/resources/os_lib_reporting_example.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/example_report/resources/report.html.erb

@@ -47,6 +47,10 @@
 
 
 
+
+
+
+
 <!DOCTYPE html>
 <html lang="en">
 <head>

data/lib/measures/gem_env_report/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/gem_env_report/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/gem_env_report/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>gem_environment_report</name>
   <uid>3f9f1a2f-0e8a-4c88-b817-10494fc3e73a</uid>
-  <version_id>ca2d6693-7e30-47d8-a8c7-0f142b651fbb</version_id>
-  <version_modified>20210406T220301Z</version_modified>
+  <version_id>c37f64ba-bdf4-4c67-a5e6-4cd01086ac36</version_id>
+  <version_modified>20221115T223606Z</version_modified>
   <xml_checksum>D1F10311</xml_checksum>
   <class_name>GemEnvironmentReport</class_name>
   <display_name>gem environment report</display_name>
@@ -55,37 +55,37 @@
       <filename>run_gem_env_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>7456CFC2</checksum>
+      <checksum>EB1D95F2</checksum>
     </file>
     <file>
       <filename>run_openstudio_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>D282E915</checksum>
+      <checksum>926943DC</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>A21A3ED2</checksum>
+      <checksum>64FFEBDE</checksum>
     </file>
     <file>
       <filename>openstudio_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>571B82E1</checksum>
+      <checksum>BA1249C5</checksum>
     </file>
     <file>
       <filename>gem_env_info.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>FA9CB397</checksum>
+      <checksum>5C631590</checksum>
     </file>
     <file>
       <filename>gem_env_report_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>DA84BDC3</checksum>
+      <checksum>96AADEF6</checksum>
     </file>
     <file>
       <version>
@@ -96,7 +96,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>7FC76C54</checksum>
+      <checksum>3D133192</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/gem_env_report/resources/gem_env_info.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/gem_env_report/resources/openstudio_info.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/gem_env_report/resources/run_gem_env_info.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/gem_env_report/resources/run_openstudio_info.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/generic_qaqc/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+OpenStudio(R), Copyright (c) 2008-2022, 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:

data/lib/measures/generic_qaqc/measure.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2022, 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: