urbanopt-reopt 0.1.0

data/doc_templates/LICENSE.md

@@ -0,0 +1,27 @@
+URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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:
+
+Redistributions of source code must retain the above copyright notice, this list 
+of conditions and the following disclaimer.
+
+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.
+ 
+Neither the name of the copyright holder nor the names of its contributors may be 
+used to endorse or promote products derived from this software without specific 
+prior written permission.
+
+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 OR 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/doc_templates/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/doc_templates/copyright_erb.txt

@@ -0,0 +1,31 @@
+<%
+  # *********************************************************************************
+  # URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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:
+  #
+  # Redistributions of source code must retain the above copyright notice, this list
+  # of conditions and the following disclaimer.
+  #
+  # 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.
+  #
+  # Neither the name of the copyright holder nor the names of its contributors may be
+  # used to endorse or promote products derived from this software without specific
+  # prior written permission.
+  #
+  # 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 OR 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/doc_templates/copyright_js.txt

@@ -0,0 +1,4 @@
+/* @preserve
+ * URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+ * Use of this source code is governed by the BSD 3-Clause license.
+*/

data/doc_templates/copyright_ruby.txt

@@ -0,0 +1,29 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# 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.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# 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 OR 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/docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.vuepress/public/rdoc/
+.vuepress/dist/

data/docs/.vuepress/components/InnerJsonSchema.vue

@@ -0,0 +1,78 @@
+<template>
+  <div>
+    <a v-if="rawMode" @click="rawMode = false">view pretty</a>
+    <a v-if="!rawMode" @click="rawMode = true">view raw</a>
+    <div v-show="!rawMode" ref="schemaTarget" class="schema-pretty"/>
+    <pre v-show="rawMode"><code v-html="schemaFormatted" class="json"/></pre>
+  </div>
+</template>
+<script>
+import "json-schema-view-js/dist/style.css";
+import "highlight.js/styles/railscasts.css";
+import highlightJson from "../highlight";
+import { emptyPromise } from '../utils';
+const JSONSchemaViewP = emptyPromise();
+const $RefParserP = emptyPromise();
+export default {
+  name: "InnerJsonSchema",
+  props: ["schema"],
+  data() {
+    return {
+      rawMode: false,
+    };
+  },
+  created() {
+    import("json-schema-view-js").then(JSONSchemaViewP.resolve);
+    import("json-schema-ref-parser/dist/ref-parser.js").then($RefParserP.resolve);
+  },
+  computed: {
+    view() {
+      return Promise.all([$RefParserP, JSONSchemaViewP])
+        .then(([$RefParser]) => $RefParser.default.dereference(this.schema))
+        .then(
+          s =>
+            new window.JSONSchemaView(s, 2, {
+              theme: "dark"
+            })
+        );
+    },
+    schemaFormatted() {
+      return highlightJson(JSON.stringify(this.schema, null, 2));
+    }
+  },
+  methods: {
+    async replaceRenderedSchema() {
+      const v = await this.view;
+      this.$refs.schemaTarget.innerHtml = "";
+      this.$refs.schemaTarget.appendChild(v.render());
+    }
+  },
+  watch: {
+    schema: {
+      handler: "replaceRenderedSchema",
+      immediate: true
+    }
+  }
+};
+</script>
+<style>
+.schema-pretty {
+  margin-top: 0.85rem;
+  background-color: #282c34;
+  padding: 1rem 1rem;
+  border-radius: 3px;
+}
+.json-formatter-row a {
+  color: white;
+}
+.json-formatter-row .json-formatter-bracket,
+.json-formatter-row .json-formatter-number {
+  color: #9090fb;
+}
+.json-formatter-row .json-formatter-key {
+  color: #8665d0;
+}
+.json-schema-view .object .inner.oneOf b {
+  color: aqua;
+}
+</style>

data/docs/.vuepress/components/JsonSchema.vue

@@ -0,0 +1,12 @@
+<template>
+  <ClientOnly>
+    <InnerJsonSchema :schema="schema" />
+  </ClientOnly>
+</template>
+
+<script>
+export default {
+  name: 'JsonSchema',
+  props: ['schema'],
+}
+</script>

data/docs/.vuepress/components/ReoptInputSchema.vue

@@ -0,0 +1,12 @@
+<template>
+  <JsonSchema :schema="schema"/>
+</template>
+<script>
+import { default as schema } from "../../../lib/urbanopt/reopt/reopt_schema/reopt_input_schema.json";
+export default {
+  name: "ReoptSchema",
+  data() {
+    return { schema };
+  }
+};
+</script>

data/docs/.vuepress/components/ReoptOutputSchema.vue

@@ -0,0 +1,12 @@
+<template>
+  <JsonSchema :schema="schema"/>
+</template>
+<script>
+import { default as schema } from "../../../lib/urbanopt/reopt/reopt_schema/reopt_output_schema.json";
+export default {
+  name: "ReoptOutputSchema",
+  data() {
+    return { schema };
+  }
+};
+</script>

data/docs/.vuepress/components/StaticLink.vue

@@ -0,0 +1,8 @@
+<script>
+export default {
+  name: "StaticLink",
+  render(h) {
+    return h("a", { domProps: this.props }, this.$slots.default);
+  }
+};
+</script>

data/docs/.vuepress/config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  base: '/urbanopt-reopt-gem/',
+  themeConfig: {
+    navbar: false,
+   sidebar: [
+     "/",
+     {
+       title: "Schemas",
+       children: [
+          "/schemas/reopt-input-schema.md",
+          "/schemas/reopt-output-schema.md"
+       ]
+     }
+   ]
+  }
+};

data/docs/.vuepress/highlight.js

@@ -0,0 +1,8 @@
+import hljs from "highlight.js/lib/highlight.js";
+import json from "highlight.js/lib/languages/json";
+
+hljs.registerLanguage("json", json);
+
+export default function(code) {
+  return hljs.highlight("json", code, true).value;
+}

data/docs/.vuepress/public/custom_rdoc_styles.css

@@ -0,0 +1,58 @@
+:link, :visited {
+    color: #3eaf7c;
+}
+:link:hover  {
+    border-bottom: 1px solid #3eaf7c;
+}
+body {
+    background-color: #fff;
+    font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif !important;
+}
+
+
+
+
+main h1, main h2, main h3, main h4, main h5, main h6 {
+    font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;
+}
+h1, h2, h3, h4, h5, h6 {
+    font-weight: 600;
+    line-height: 1.25;
+}
+main h1 {
+    margin-top: 1.5rem !important;
+    margin-bottom: 1rem;
+    font-size: 2.2rem;
+}
+
+#home-section, #search-section, #fileindex-section {
+    display: none !important;
+}
+.nav-section h3 {
+    color: #999;
+    font-size: 1.1em;
+    font-weight: 700;
+    background-color: #fff;
+    text-align: left;
+}
+nav .nav-section {
+    border-top: none;
+    font-size: unset;
+}
+
+.link-list a {
+    display: inline-block;
+    padding: .35rem 1rem .35rem 2rem;
+    font-weight: 400;
+    color: #2c3e50;
+    border-left: .25rem solid transparent;
+    padding: .35rem 1rem .35rem 1.25rem;
+    line-height: 1.4;
+    width: 100%;
+    box-sizing: border-box;
+}
+.link-list a:hover, .link-list :link:hover {
+    color: #3eaf7c;
+    border-bottom: none;
+}
+

data/docs/.vuepress/utils.js

@@ -0,0 +1,17 @@
+export function emptyPromise() {
+    let res;
+    let rej;
+    const p = new Promise((resolve, reject) => {
+      res = resolve;
+      rej = reject;
+    });
+    p.pending = true;
+    p.resolved = p.rejected = null;
+    p.resolve = (...args) => {
+      res(...args); p.resolved = true; p.rejected = false; p.pending = false;
+    };
+    p.reject = (...args) => {
+      rej(...args); p.rejected = true; p.resolved = false; p.pending = false;
+    };
+    return p;
+  }

data/docs/README.md

@@ -0,0 +1,196 @@
+# URBANopt REopt Gem
+
+### <StaticLink target="\_blank" href="rdoc/">Rdocs</StaticLink>
+
+The **URBANopt REopt Gem** extends a **URBANopt::Scenario::DefaultReports::ScenarioReport** and **URBANopt::Scenario::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the <StaticLink target="\_blank" href="https://reopt.nrel.gov/tool">REopt Lite</StaticLink> decision support platform. 
+REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions. 
+
+The REopt Gem accomplishes three basic functions (described more below in the _Functionality_ section):
+
+1. Accepts a json (or hash) of **assumptions** (i.e. utility rate, installation costs, escalation rates) to use in running REopt for a Scenario or Feature Report
+2. Updates the **distributed_generation** attributes of a Feature Report or Scenario Report based on a cost-optimal DER system
+3. Updates the **timeseries_CSV** attributes of a Feature Report or Scenario Report based on the dispatch of a cost-optimal DER system
+
+Moreover, the REopt Gem can be run in several modes, either on:
+
+ * A Feature Report, 
+ * A collection of Feature Reports 
+ * All the features in a Scenario Report before aggregating results at the scenario level
+ * The collection of features in aggregate as summarized in a Scenario Report
+
+See the <StaticLink target="\_blank" href="https://github.com/urbanopt/urbanopt-example-reopt-project.git">example project</StaticLink> for more infomation about usage of this gem.
+
+<b>Note:</b> This module requires an API Key from the <StaticLink target='blank' href="https://developer.nrel.gov/">NREL Developer Network</StaticLink>.
+
+<StaticLink target="\_blank" href="https://urbanopt.github.io/urbanopt-reopt-gem/">RDoc Documentation</StaticLink>
+
+
+## Installation
+
+See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including: 
+- Ruby 2.2.6
+- Bundler 1.17.0
+- OpenStudio 2.8.1
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-reopt'
+```
+
+And then execute:
+
+    $ bundle install
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-reopt'
+
+## Functionality
+
+This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below: 
+```
+	"distributed_generation": {
+	      "lcc_us_dollars": 100000000.0,
+	      "npv_us_dollars": 10000000.0,
+	      "year_one_energy_cost_us_dollars": 7000000.0,
+	      "year_one_demand_cost_us_dollars": 3000000.0,
+	      "year_one_bill_us_dollars": 10000000.0,
+	      "total_energy_cost_us_dollars": 70000000.0,
+	      "solar_pv": {
+	        "size_kw": 30000.0
+	      },
+	      "wind": {
+	        "size_kw": 0.0
+	      },
+	      "generator": {
+	        "size_kw": 0.0
+	      },
+	      "storage": {
+	        "size_kw": 2000.0,
+	        "size_kwh": 5000.0
+	      }
+	    }
+```
+
+Moreover, the following optimal dispatch fields are added to its timeseries CSV. Where no system component is recommended the dispatch will be all zero (i.e. if no solar PV is recommended ElectricityProduced:PV:Total will be always be zero)
+
+|            output                        |  unit   |
+| -----------------------------------------| ------- |
+| ElectricityProduced:Total                | kWh     |
+| Electricity:Load:Total                   | kWh     |
+| Electricity:Grid:ToLoad                  | kWh     |
+| Electricity:Grid:ToBattery               | kWh     |
+| Electricity:Storage:ToLoad               | kWh     |
+| Electricity:Storage:ToGrid               | kWh     |
+| Electricity:Storage:StateOfCharge        | kWh     |
+| ElectricityProduced:Generator:Total      | kWh     |
+| ElectricityProduced:Generator:ToBattery  | kWh     |
+| ElectricityProduced:Generator:ToLoad     | kWh     |
+| ElectricityProduced:Generator:ToGrid     | kWh     |
+| ElectricityProduced:PV:Total             | kWh     |
+| ElectricityProduced:PV:ToBattery         | kWh     |
+| ElectricityProduced:PV:ToLoad            | kWh     |
+| ElectricityProduced:PV:ToGrid            | kWh     |
+| ElectricityProduced:Wind:Total           | kWh     |
+| ElectricityProduced:Wind:ToBattery       | kWh     |
+| ElectricityProduced:Wind:ToLoad          | kWh     |
+| ElectricityProduced:Wind:ToGrid          | kWh     |
+    
+
+The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions. 
+
+<b>Note:</b> Required attributes for a REopt run include latitude and longitude, parsed from the Feature or Scenario Report attributes. If no utility rate is specified in your assumptions, then a constant rate of $0.13 is assumed without demand charges. Also, by default, only solar PV and storage are considered in the analysis (i.e. Wind and Generators are excluded from consideration).
+
+
+
+## Getting Started
+
+The code below shows how to run the REopt API on a single Feature Report hash using this gem:
+
+```ruby
+require 'urbanopt/reopt'
+
+DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.gov/signup >
+
+#Load a Feature Report Hash
+feature_reports_hash = {} # <insert a valid Feature Report hash here with latitude and longitude filled in>
+
+#Create a Feature Report
+feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
+
+#Specify a file name where REopt Lite results will be written in JSON format
+reopt_output_file = File.join(feature_report.directory_name, 'feature_report_reopt_run.json')
+
+#Specify a file name where the new timeseries CSV will be written after REopt Lite has determined cost optimal dispatch
+timeseries_output_file = File.join(feature_report.directory_name, 'feature_report_timeseries.csv')
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), '../files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_NREL_KEY)
+
+#Call REopt Lite with the post processor to update the feature's distributed generation attributes and timeseries CSV.
+updated_feature_report = reopt_post_processor.run_feature_report(feature_report,reopt_assumptions_file,reopt_output_file,timeseries_output_file)
+    
+```
+
+More commonly, this gem can be used to run REopt a collection of features stored in a Scenario Report as show here:
+```ruby
+require 'urbanopt/reopt'
+DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.gov/signup >
+
+#Create a Scenario Report
+scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), 'run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), 'run/example_scenario/timeseries.csv') }})
+
+#Load Feature Reports into the Scenario Report     
+(1..2).each do |i|
+  feature_reports_path = File.join(File.dirname(__FILE__), "run/example_scenario/#{i}/010_default_feature_reports/default_feature_reports.json")
+
+  feature_reports_hash = nil
+  File.open(feature_reports_path, 'r') do |file|
+    feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
+  end
+
+  feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
+  
+  feature_report_dir = File.join(File.dirname(__FILE__), "run/example_scenario/#{i}")
+  feature_report.directory_name = feature_report_dir
+
+  scenario_report.add_feature_report(feature_report)
+end
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), 'files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_NREL_KEY)
+
+#Call REopt Lite with the post processor once on the sceanrio's aggregated load to update the scenario's distributed generation attributes and timeseries CSV.
+updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_report)
+    
+```
+
+## Testing
+
+First, check out the repository (i.e. git clone this repo).
+
+Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
+
+    DEVELOPER_NREL_KEY = '<insert your key here>'
+
+Finally, execute:
+
+    $ bundle install
+    $ bundle update    
+    $ bundle exec rake
+
+
+## Releasing
+
+* Update change log
+* Update version in `/lib/urbanopt/reopt/version.rb`
+* Merge down to master
+* run `rake release` from master