lbt-measures 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cfb82786f5aebc9b1c98b395067bca39937be7c492d7d3cb03da0e7f31c813c
+  data.tar.gz: 7300b076bebfdbcf1596b84813c709f770de598a130ce912678f81f6907a148f
+SHA512:
+  metadata.gz: da96b007a05b62df9a1582be8a85c50b50448fe1bf51174215d823bdcf7f47b0be0a6e0f0f9d4117fd33c1d1896b970a8775379cffffc8714cb053e30a79edb3
+  data.tar.gz: 9de2bf9aecfa609b086e6eb17bbdbcf584ca597049706c358aebe5c39d8f13eac00a9722e1fed767fed9d2238a813bfa5c61f54f85c2d7d47dfa3baabf42d04b

data/.github/workflows/ci.yaml

@@ -0,0 +1,63 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+
+  deploy:
+    name: Deploy to GitHub and Rubygems.org
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master' && github.repository_owner == 'ladybug-tools'
+    steps:
+      - uses: actions/checkout@v3
+      - name: set up node  # we need node for for semantic release
+        uses: actions/setup-node@v3.6.0
+        with:
+          node-version: 14.17.0
+      - name: install semantic-release
+        run:
+          npm install @semantic-release/exec
+      - name: run semantic release
+        uses: cycjimmy/semantic-release-action@v3
+        id: semantic   # Need an `id` for output variables
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Update gemspec
+        if: steps.semantic.outputs.new_release_published == 'true'
+        env:
+          RELEASE_TAG: ${{ steps.semantic.outputs.new_release_version }}
+        run: |
+          export CLEAN_TAG=$(echo $RELEASE_TAG | sed 's/v//g')
+          sed -i 's/"0.0.0"/'"'$CLEAN_TAG'"'/g' lbt-measures.gemspec
+      - name: Release Gem
+        if: steps.semantic.outputs.new_release_published == 'true'
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}
+      - name: Update lbt-grasshopper
+        if: steps.semantic.outputs.new_release_published == 'true'
+        env:
+          RELEASE_TAG: ${{ steps.semantic.outputs.new_release_version }}
+          DISPATCH_REPO: ladybug-tools/lbt-grasshopper
+          DEPS_TOKEN: ${{ secrets.DEPS_UPDATING }}
+        run: |
+          curl -X POST https://api.github.com/repos/$DISPATCH_REPO/dispatches \
+          -H "Accept: application/vnd.github.everest-preview+json" \
+          -d '{
+            "event_type": "lbt_measures_release",
+            "client_payload": {
+              "version" : "'$RELEASE_TAG'"
+            }
+          }' \
+          -u ladybugbot:$DEPS_TOKEN
+      - name: Update honeybee-energy
+        if: steps.semantic.outputs.new_release_published == 'true'
+        env:
+          RELEASE_TAG: ${{ steps.semantic.outputs.new_release_version }}
+          DISPATCH_REPO: ladybug-tools/honeybee-energy
+          DEPS_TOKEN: ${{ secrets.DEPS_UPDATING }}
+        run: |
+          curl -X POST https://api.github.com/repos/$DISPATCH_REPO/dispatches \
+          -H "Accept: application/vnd.github.everest-preview+json" \
+          -d '{"event_type": "lbt_measures_release", "client_payload": {"version": "'$RELEASE_TAG'"}}' \
+          -u ladybugbot:$DEPS_TOKEN

data/.gitignore

@@ -0,0 +1,34 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/gems
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/coverage/
+/spec/output/
+/spec/reports/
+/spec/test/
+/tmp/
+/test/
+/lib/measures/test_results
+/lib/measures/.rubocop*
+/.vscode
+/.vs
+
+# rspec failure tracking
+.rspec_status
+.rakeTasks
+
+# Ignore IDE files
+/.idea
+*.rubocop-http*
+
+# measures tests
+lib/measures/.rubocop.yml
+lib/measures/test_results/*
+lib/measures/*/tests/output
+
+out.txt

data/.releaserc.json

@@ -0,0 +1,7 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github"
+    ]
+}

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies
+gemspec
+
+# get the openstudio-extension gem
+if File.exist?('../OpenStudio-extension-gem')  # local development copy
+  gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
+else  # get it from rubygems.org
+  gem 'openstudio-extension', '0.8.3'
+end

data/LICENSE.md

@@ -0,0 +1,23 @@
+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.

data/README.md

@@ -0,0 +1,13 @@
+# lbt-measures
+
+:straight_ruler: :straight_ruler: :straight_ruler: Collection of
+[Openstudio measures](https://nrel.github.io/OpenStudio-user-documentation/getting_started/about_measures/)
+that ship with the Ladybug Tools plugins.
+
+Most (if not all) of the measures in this gem can be found on the [BCL](https://bcl.nrel.gov/)
+and are maintained by [NREL](https://www.nrel.gov/) or other contributors. However,
+the versions of the measures in this gem are regularly tested for compatibility
+with Ladybug Tools.
+
+Given that different measures can have different authors, one should refer to the
+individual license files with each measure for limitations about redistribution.

data/lbt-measures.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lbt-measures'
+  spec.version       = '0.3.2'
+  spec.authors       = ['Dan Macumber', 'Chris Mackey']
+  spec.email         = ['chris@ladybug.tools']
+
+  spec.summary       = 'Collection of measures that ship with Ladybug Tools plugins.'
+  spec.description   = 'Measures that ship with Ladybug Tools plugins and are regularly tested for compatibility with them.'
+  spec.homepage      = 'https://github.com/ladybug-tools/lbt-measures'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  if /^3.2.2/.match(RUBY_VERSION)
+    spec.required_ruby_version = "~> 3.2.2"
+    spec.add_development_dependency "bundler",        "~> 2.4.10"
+  end
+
+  spec.add_dependency 'openstudio-extension', '0.8.3'
+
+end

data/lib/efficiency_standard/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2021, 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:
+
+(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.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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/efficiency_standard/README.md

@@ -0,0 +1,32 @@
+
+
+###### (Automatically generated documentation)
+
+#  Apply Efficiency Standard
+
+## Description
+Apply an efficiency standard to HVAC equipment using openStudio-standards
+
+## Modeler Description
+
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### Standard
+Text for the standard to be applied to the HVAC equipment. Choose from the following. DOE_Ref_Pre_1980, DOE_Ref_1980_2004, ASHRAE_2004, ASHRAE_2007, ASHRAE_2010, ASHRAE_2013, ASHRAE_2016, ASHRAE_2019
+**Name:** standard,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/efficiency_standard/README.md.erb

@@ -0,0 +1,42 @@
+<%#= 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] %>
+<% 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 %>

data/lib/efficiency_standard/measure.rb

@@ -0,0 +1,142 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2021, 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:
+#
+# (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.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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.
+# *******************************************************************************
+
+# see the URL below for information on how to write OpenStudio measures
+# http://openstudio.nrel.gov/openstudio-measure-writing-guide
+
+# see your EnergyPlus installation or the URL below for information on EnergyPlus objects
+# http://apps1.eere.energy.gov/buildings/energyplus/pdfs/inputoutputreference.pdf
+
+# see the URL below for information on using life cycle cost objects in OpenStudio
+# http://openstudio.nrel.gov/openstudio-life-cycle-examples
+
+# see the URL below for access to C++ documentation on workspace objects (click on "workspace" in the main window to view workspace objects)
+# http://openstudio.nrel.gov/sites/openstudio.nrel.gov/files/nv_data/cpp_documentation_it/utilities/html/idf_page.html
+
+require 'openstudio-standards'
+
+# start the measure
+class ApplyEfficiencyStandard < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    return ' Apply Efficiency Standard'
+  end
+
+  # human readable description
+  def description
+    return 'Apply an efficiency standard to HVAC equipment using openStudio-standards.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'Apply an efficiency standard to HVAC equipment using openStudio-standards.'
+  end
+
+  # define the arguments that the user will input
+  def arguments(workspace)
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # make an argument for external idf
+    standard = OpenStudio::Measure::OSArgument.makeStringArgument('standard', true)
+    standard.setDisplayName('Standard to Apply')
+    standard.setDescription('Text for the standard to be applied to the HVAC equipment. Choose from the following. DOE_Ref_Pre_1980, DOE_Ref_1980_2004, ASHRAE_2004, ASHRAE_2007, ASHRAE_2010, ASHRAE_2013, ASHRAE_2016, ASHRAE_2019')
+    args << standard
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+    STDOUT.flush
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # get the standard to apply
+    standard_str = runner.getStringArgumentValue('standard', user_arguments)
+    standard_mapper = {
+      DOE_Ref_Pre_1980: 'DOE Ref Pre-1980',
+      DOE_Ref_1980_2004: 'DOE Ref 1980-2004',
+      ASHRAE_2004: '90.1-2004',
+      ASHRAE_2007: '90.1-2007',
+      ASHRAE_2010: '90.1-2010',
+      ASHRAE_2013: '90.1-2013',
+      ASHRAE_2016: '90.1-2016',
+      ASHRAE_2019: '90.1-2019'
+    }
+    std_gem_standard = standard_mapper[standard_str.to_sym]
+    # std_gem_standard = '90.1-2019'
+    building = model.getBuilding
+    building.setStandardsTemplate(std_gem_standard)
+    standard_id = building.standardsTemplate.get
+    standard = Standard.build(standard_id)
+
+    # Set the heating and cooling sizing parameters
+    puts 'Autosizing HVAC systems and assigning efficiencies'
+    standard.model_apply_prm_sizing_parameters(model)
+    # Perform a sizing run
+    if standard.model_run_sizing_run(model, "#{Dir.pwd}/SR1") == false
+      log_messages_to_runner(runner, debug = true)
+      return false
+    end
+    puts 'Done with autosizing HVAC systems!'
+    # If there are any multizone systems, reset damper positions
+    # to achieve a 60% ventilation effectiveness minimum for the system
+    # following the ventilation rate procedure from 62.1
+    standard.model_apply_multizone_vav_outdoor_air_sizing(model)
+    # get the climate zone  
+    climate_zone_obj = model.getClimateZones.getClimateZone('ASHRAE', 2006)
+    if climate_zone_obj.empty
+      climate_zone_obj = model.getClimateZones.getClimateZone('ASHRAE', 2013)
+    end
+    climate_zone = climate_zone_obj.value
+    # get the building type
+    bldg_type = nil
+    unless building.standardsBuildingType.empty?
+      bldg_type = building.standardsBuildingType.get
+    end
+    # Apply the prototype HVAC assumptions
+    standard.model_apply_prototype_hvac_assumptions(model, bldg_type, climate_zone)
+    # Apply the HVAC efficiency standard
+    standard.model_apply_hvac_efficiency_standard(model, climate_zone)
+    puts 'Done with applying efficiencies!'
+
+    return true
+  end
+end
+
+# this allows the measure to be use by the application
+ApplyEfficiencyStandard.new.registerWithApplication

data/lib/efficiency_standard/measure.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>apply_efficiency_standard</name>
+  <uid>89367df4-a09c-4125-b5c3-1417bd04a552</uid>
+  <version_id>9b6b3ec5-5f6d-4444-a30c-c34b8efd766d</version_id>
+  <version_modified>20210406T220305Z</version_modified>
+  <xml_checksum>A8BAB05F</xml_checksum>
+  <class_name>ApplyEfficiencyStandard</class_name>
+  <display_name>Apply Efficiency Standard</display_name>
+  <description>Apply an efficiency standard to HVAC equipment using openStudio-standards.</description>
+  <modeler_description>Apply an efficiency standard to HVAC equipment using openStudio-standards.</modeler_description>
+  <arguments>
+    <argument>
+      <name>standard</name>
+      <display_name>Standard to Apply</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Whole Building.Space Types</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Uses SketchUp API</name>
+      <value>false</value>
+      <datatype>boolean</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>70F4784D</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>64FFEBDE</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>2.7.0</identifier>
+        <min_compatible>2.7.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>39164A78</checksum>
+    </file>
+  </files>
+</measure>

data/lib/inject_idf/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2021, 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:
+
+(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.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS 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/inject_idf/README.md

@@ -0,0 +1,32 @@
+
+
+###### (Automatically generated documentation)
+
+#  Inject IDF Objects
+
+## Description
+
+
+## Modeler Description
+
+
+## Measure Type
+EnergyPlusMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### External IDF File Name
+Name of the IDF file to inject objects from. This is the filename with the extension (e.g. MyModel.idf). Optionally this can inclucde the full file path, but for most use cases should just be file name.
+**Name:** source_idf_path,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/inject_idf/README.md.erb

@@ -0,0 +1,42 @@
+<%#= 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] %>
+<% 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 %>