openstudio-calibration 0.1.2

data/lib/measures/AddMonthlyUtilityData/measure.xml

@@ -0,0 +1,115 @@
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>add_monthly_utility_data</name>
+  <uid>6da969e0-4256-49bf-9607-26504cc3d421</uid>
+  <version_id>20a22623-b2ff-4b69-b182-2dea1bf995b3</version_id>
+  <version_modified>20200325T030944Z</version_modified>
+  <xml_checksum>9064277D</xml_checksum>
+  <class_name>AddMonthlyUtilityData</class_name>
+  <display_name>AddMonthlyUtilityData</display_name>
+  <description>Reads in custom format and adds utility data</description>
+  <modeler_description>Minimum interval for utility data is one day</modeler_description>
+  <arguments>
+    <argument>
+      <name>electric_json</name>
+      <display_name>Path to electric JSON</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>gas_json</name>
+      <display_name>Path to gas JSON</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>water_json</name>
+      <display_name>Path to water JSON</display_name>
+      <type>String</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>start_date</name>
+      <display_name>Start date</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>end_date</name>
+      <display_name>End date</display_name>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+  </arguments>
+  <outputs/>
+  <provenances/>
+  <tags>
+    <tag>Economics.Life Cycle Cost Analysis</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>electric_billed_usages.json</filename>
+      <filetype>json</filetype>
+      <usage_type>test</usage_type>
+      <checksum>5F884191</checksum>
+    </file>
+    <file>
+      <filename>gas_billed_usages.json</filename>
+      <filetype>json</filetype>
+      <usage_type>test</usage_type>
+      <checksum>379ABCEE</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
+    </file>
+    <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>A8846AF4</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>CC58EE3A</checksum>
+    </file>
+    <file>
+      <filename>AddMonthlyUtilityData_Test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>977DB51C</checksum>
+    </file>
+  </files>
+</measure>

data/lib/measures/AddMonthlyUtilityData/tests/AddMonthlyUtilityData_Test.rb

@@ -0,0 +1,88 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, 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.
+# *******************************************************************************
+
+require 'openstudio'
+
+require 'openstudio/ruleset/ShowRunnerOutput'
+
+require "#{File.dirname(__FILE__)}/../measure.rb"
+
+require 'minitest/autorun'
+
+class AddMonthlyUtilityData_Test < Minitest::Test
+  def test_AddMonthlyUtilityData
+    # create an instance of the measure
+    measure = AddMonthlyUtilityData.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    # make an empty model
+    model = OpenStudio::Model::Model.new
+
+    # get arguments and test that they are what we are expecting
+    arguments = measure.arguments(model)
+    assert_equal(5, arguments.size)
+    assert_equal('electric_json', arguments[0].name)
+    assert_equal('gas_json', arguments[1].name)
+    assert_equal('water_json', arguments[2].name)
+    assert_equal('start_date', arguments[3].name)
+    assert_equal('end_date', arguments[4].name)
+
+    # set argument values to good values and run the measure on model with spaces
+    argument_map = OpenStudio::Measure::OSArgumentMap.new
+
+    electric_json = arguments[0].clone
+    assert(electric_json.setValue(File.dirname(__FILE__) + '/electric_billed_usages.json'))
+    argument_map['electric_json'] = electric_json
+
+    gas_json = arguments[1].clone
+    assert(gas_json.setValue(File.dirname(__FILE__) + '/gas_billed_usages.json'))
+    argument_map['gas_json'] = gas_json
+
+    start_date = arguments[2].clone
+    assert(start_date.setValue('2012-06-19'))
+    argument_map['start_date'] = start_date
+
+    end_date = arguments[3].clone
+    assert(end_date.setValue('2013-05-20'))
+    argument_map['end_date'] = end_date
+
+    measure.run(model, runner, argument_map)
+    result = runner.result
+    show_output(result)
+    assert(result.value.valueName == 'Success')
+  end
+end

data/lib/measures/AddMonthlyUtilityData/tests/electric_billed_usages.json

@@ -0,0 +1,198 @@
+{ "data": [
+    {
+        "accounts": 1,
+        "from": "2011-12-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-01-06T00:00:00Z",
+        "tot_kwh": 1
+    },
+    {
+        "accounts": 1,
+        "from": "2012-01-06T00:00:00Z",
+        "peak": 0,
+        "to": "2012-02-02T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-02-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-03-05T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-03-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-04-02T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-04-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-05-02T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-05-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-06-04T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-06-04T00:00:00Z",
+        "peak": 0,
+        "to": "2012-07-02T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-07-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-08-02T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-08-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-09-05T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-09-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-10-02T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-10-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-11-05T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-11-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-12-04T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-12-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-01-03T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-01-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-02-01T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-02-01T00:00:00Z",
+        "peak": 0,
+        "to": "2013-03-04T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-03-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-04-02T00:00:00Z",
+        "tot_kwh": 4
+    },
+    {
+        "accounts": 1,
+        "from": "2013-04-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-05-03T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-05-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-06-04T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-06-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-07-02T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-07-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-08-02T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-08-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-09-05T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-09-05T00:00:00Z",
+        "peak": 0,
+        "to": "2013-10-03T00:00:00Z",
+        "tot_kwh": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-10-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-10-31T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-10-31T00:00:00Z",
+        "peak": 0,
+        "to": "2013-12-03T00:00:00Z",
+        "tot_kwh": 4
+    },
+    {
+        "accounts": 1,
+        "from": "2013-12-03T00:00:00Z",
+        "peak": 0,
+        "to": "2014-01-06T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-01-06T00:00:00Z",
+        "peak": 0,
+        "to": "2014-02-03T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-02-03T00:00:00Z",
+        "peak": 0,
+        "to": "2014-03-04T00:00:00Z",
+        "tot_kwh": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-03-04T00:00:00Z",
+        "peak": 0,
+        "to": "2014-04-02T00:00:00Z",
+        "tot_kwh": 3
+    }
+] }

data/lib/measures/AddMonthlyUtilityData/tests/gas_billed_usages.json

@@ -0,0 +1,198 @@
+{ "data": [
+    {
+        "accounts": 1,
+        "from": "2011-12-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-01-06T00:00:00Z",
+        "tot_therms": 1
+    },
+    {
+        "accounts": 1,
+        "from": "2012-01-06T00:00:00Z",
+        "peak": 0,
+        "to": "2012-02-02T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-02-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-03-05T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-03-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-04-02T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-04-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-05-02T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-05-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-06-04T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-06-04T00:00:00Z",
+        "peak": 0,
+        "to": "2012-07-02T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-07-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-08-02T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-08-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-09-05T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-09-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-10-02T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2012-10-02T00:00:00Z",
+        "peak": 0,
+        "to": "2012-11-05T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-11-05T00:00:00Z",
+        "peak": 0,
+        "to": "2012-12-04T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2012-12-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-01-03T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-01-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-02-01T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-02-01T00:00:00Z",
+        "peak": 0,
+        "to": "2013-03-04T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-03-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-04-02T00:00:00Z",
+        "tot_therms": 4
+    },
+    {
+        "accounts": 1,
+        "from": "2013-04-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-05-03T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-05-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-06-04T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-06-04T00:00:00Z",
+        "peak": 0,
+        "to": "2013-07-02T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-07-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-08-02T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-08-02T00:00:00Z",
+        "peak": 0,
+        "to": "2013-09-05T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-09-05T00:00:00Z",
+        "peak": 0,
+        "to": "2013-10-03T00:00:00Z",
+        "tot_therms": 2
+    },
+    {
+        "accounts": 1,
+        "from": "2013-10-03T00:00:00Z",
+        "peak": 0,
+        "to": "2013-10-31T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2013-10-31T00:00:00Z",
+        "peak": 0,
+        "to": "2013-12-03T00:00:00Z",
+        "tot_therms": 4
+    },
+    {
+        "accounts": 1,
+        "from": "2013-12-03T00:00:00Z",
+        "peak": 0,
+        "to": "2014-01-06T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-01-06T00:00:00Z",
+        "peak": 0,
+        "to": "2014-02-03T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-02-03T00:00:00Z",
+        "peak": 0,
+        "to": "2014-03-04T00:00:00Z",
+        "tot_therms": 3
+    },
+    {
+        "accounts": 1,
+        "from": "2014-03-04T00:00:00Z",
+        "peak": 0,
+        "to": "2014-04-02T00:00:00Z",
+        "tot_therms": 3
+    }
+] }