urbanopt-reopt 0.7.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/nightly_build.yml +36 -0
  3. data/CHANGELOG.md +32 -0
  4. data/Gemfile +1 -3
  5. data/LICENSE.md +1 -13
  6. data/RDOC_MAIN.md +2 -2
  7. data/README.md +4 -2
  8. data/Rakefile +1 -1
  9. data/developer_nrel_key.rb +1 -1
  10. data/doc_templates/LICENSE.md +17 -17
  11. data/doc_templates/copyright_erb.txt +2 -2
  12. data/doc_templates/copyright_js.txt +2 -2
  13. data/doc_templates/copyright_ruby.txt +2 -2
  14. data/docs/README.md +2 -2
  15. data/docs/package-lock.json +6199 -4852
  16. data/index.md +2 -2
  17. data/lib/urbanopt/reopt/extension.rb +6 -16
  18. data/lib/urbanopt/reopt/feature_report_adapter.rb +23 -19
  19. data/lib/urbanopt/reopt/reopt_lite_api.rb +26 -32
  20. data/lib/urbanopt/reopt/reopt_logger.rb +9 -16
  21. data/lib/urbanopt/reopt/reopt_post_processor.rb +25 -25
  22. data/lib/urbanopt/reopt/reopt_schema/reopt_input_schema.json +1 -2
  23. data/lib/urbanopt/reopt/reopt_schema/reopt_output_schema.json +6 -1
  24. data/lib/urbanopt/reopt/scenario/reopt_scenario_csv.rb +7 -17
  25. data/lib/urbanopt/reopt/scenario_report_adapter.rb +74 -47
  26. data/lib/urbanopt/reopt/utilities.rb +30 -0
  27. data/lib/urbanopt/reopt/version.rb +7 -17
  28. data/lib/urbanopt/reopt.rb +6 -16
  29. data/lib/urbanopt/reopt_scenario.rb +6 -16
  30. data/lib/urbanopt-reopt.rb +6 -16
  31. data/urbanopt-reopt.gemspec +3 -2
  32. metadata +25 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eec478250ecf8bdec94ae33f558aad94f9b3e5d4ef6cbbfdf5dd647e9f64c656
4
- data.tar.gz: a559e82e18a49edaf0a988ee59633322fe824f51d5f93fd1395b86035460b038
3
+ metadata.gz: bcab5483cee799a1e44ed9d9ecba63a8ac92c4437c62c0dd25af52b4afbc7173
4
+ data.tar.gz: 85249e213f43e34ba0b912e591de4b97f32ab8c720023a21b44fe09a8990b400
5
5
  SHA512:
6
- metadata.gz: 2ebc15e53c0f7d856df920bb201c385f0816a4501cfd5f527324c3d33a0bc750b6153514da7f1ec0594925c2537648afb88294e77c56a54c603fcea27b971d57
7
- data.tar.gz: 9e3862abfff7a0ed47ec3c65e11140f505cc43643f1a3c55360083e634262e714b0094502ecae536307b2218515a0ca09451192146400d1964fa567b44955611
6
+ metadata.gz: f7d8a115244f0df051d199829c00ea1b6d43f4163a5cb3dd07e4df249ba067a4d52dbf7ba20373a7d20b3ef1ed254c64c233d5812b4d094b538dad6ee9a1096c
7
+ data.tar.gz: daecf105673a8fa10a26626c6d253c5e096028e223d9cd27339b25ef5f267c771a796195cc1d72d378a15a9e4dd63fc0db14e26fd49923d66d49f06b504f7adc
data/.github/workflows/nightly_build.yml ADDED
@@ -0,0 +1,36 @@
1
+ name: nightly_build
2
+
3
+ on:
4
+ # push:
5
+ schedule:
6
+ # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
7
+ # 5:23 am UTC (11:23pm MDT the day before) every weekday night in MDT
8
+ - cron: '23 5 * * 2-6'
9
+
10
+ env:
11
+ # This env var should enforce develop branch of all dependencies
12
+ FAVOR_LOCAL_GEMS: true
13
+ GEM_DEVELOPER_KEY: ${{ secrets.GEM_DEVELOPER_KEY }}
14
+
15
+ jobs:
16
+ weeknight-tests:
17
+ # Pinned to `ubuntu-20.04`. When ubuntu-latest adopts 22.04 it would break for us since 22 only supports Ruby 3.1
18
+ # https://github.com/ruby/setup-ruby#supported-platforms
19
+ runs-on: ubuntu-20.04
20
+ container:
21
+ image: docker://nrel/openstudio:3.4.0
22
+ steps:
23
+ - name: Checkout code
24
+ uses: actions/checkout@v3
25
+ - name: Update gems
26
+ run: |
27
+ bundle update
28
+ bundle exec certified-update
29
+ - name: Run Rspec
30
+ run: bundle exec rspec
31
+ # coveralls action docs: https://github.com/marketplace/actions/coveralls-github-action
32
+ - name: Coveralls
33
+ uses: coverallsapp/github-action@master
34
+ with:
35
+ github-token: ${{ secrets.GITHUB_TOKEN }}
36
+ path-to-lcov: "./coverage/lcov/urbanopt-reopt-gem.lcov"
data/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # URBANopt REopt Gem
2
2
 
3
+ ## Version 0.9.0
4
+
5
+ Date Range: 05/11/22 - 12/13/22
6
+
7
+ - Update dependencies for OpenStudio 3.5.0
8
+ - Fixed [#102]( https://github.com/urbanopt/urbanopt-reopt-gem/issues/102 ), update REopt API to v2 by 10/1/2022
9
+ - Fixed [#113]( https://github.com/urbanopt/urbanopt-reopt-gem/issues/113 ), Passing test includes an output error.
10
+ - Fixed [#122]( https://github.com/urbanopt/urbanopt-reopt-gem/issues/122 ), REopt gem test review
11
+ - Fixed [#124]( https://github.com/urbanopt/urbanopt-reopt-gem/issues/124 ), Code coverage reporting
12
+
13
+ ## Version 0.8.0
14
+
15
+ Date Range: 11/23/21 - 05/10/22
16
+
17
+ - Fixed [#95]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/95 ), adding additional PV fields to UO reports
18
+ - Fixed [#98]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/98 ), updates for OpenStudio 3.3
19
+ - Fixed [#99]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/99 ), fix dependencies
20
+ - Fixed [#100]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/100 ), Bump url-parse from 1.5.1 to 1.5.2 in /docs
21
+ - Fixed [#104]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/104 ), adding REopt results to URBANopt reports
22
+ - Fixed [#105]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/105 ), Bump follow-redirects from 1.13.3 to 1.14.8 in /docs
23
+ - Fixed [#106]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/106 ), Bump nanoid from 3.1.23 to 3.3.0 in /docs
24
+ - Fixed [#107]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/107 ), Bump url-parse from 1.5.1 to 1.5.6 in /docs
25
+ - Fixed [#108]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/108 ), Bump prismjs from 1.23.0 to 1.27.0 in /docs
26
+ - Fixed [#109]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/109 ), Bump url-parse from 1.5.1 to 1.5.8 in /docs
27
+ - Fixed [#110]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/110 ), Bump url-parse from 1.5.1 to 1.5.9 in /docs
28
+ - Fixed [#111]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/111 ), Renewable pct
29
+ - Fixed [#114]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/114 ), Bump nanoid from 3.1.23 to 3.3.1 in /docs
30
+ - Fixed [#115]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/115 ), Bump follow-redirects from 1.13.3 to 1.14.9 in /docs
31
+ - Fixed [#116]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/116 ), Bump minimist from 1.2.5 to 1.2.6 in /docs
32
+ - Fixed [#117]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/117 ), Update copyrights
33
+ - Fixed [#118]( https://github.com/urbanopt/urbanopt-reopt-gem/pull/118 ), Bump async from 2.6.3 to 2.6.4 in /docs
34
+
3
35
  ## Version 0.7.0
4
36
 
5
37
  Date Range: 10/16/21 - 11/22/21:
data/Gemfile CHANGED
@@ -42,7 +42,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
42
42
  # end
43
43
 
44
44
  # if allow_local && File.exist?('../urbanopt-scenario-gem')
45
- # gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
45
+ # gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
46
46
  # elsif allow_local
47
47
  # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
48
48
  # end
@@ -52,5 +52,3 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
52
52
  # elsif allow_local
53
53
  # gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
54
54
  # end
55
-
56
- # gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
data/LICENSE.md CHANGED
@@ -1,6 +1,4 @@
1
- # License
2
-
3
- URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
1
+ URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
4
2
  contributors. All rights reserved.
5
3
 
6
4
  Redistribution and use in source and binary forms, with or without modification,
@@ -17,16 +15,6 @@ Neither the name of the copyright holder nor the names of its contributors may b
17
15
  used to endorse or promote products derived from this software without specific
18
16
  prior written permission.
19
17
 
20
- Redistribution of this software, without modification, must refer to the software
21
- by the same designation. Redistribution of a modified version of this software
22
- (i) may not refer to the modified version by the same designation, or by any
23
- confusingly similar designation, and (ii) must refer to the underlying software
24
- originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
25
- the term “URBANopt”, or any confusingly similar designation may not be used to
26
- refer to any modified version of this software or any modified version of the
27
- underlying software originally provided by Alliance without the prior written
28
- consent of Alliance.
29
-
30
18
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
31
19
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32
20
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
data/RDOC_MAIN.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # **URBANopt REopt Gem**
2
2
 
3
3
  The **URBANopt™ REopt Gem** extends **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform.
4
- 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 [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
4
+ 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 [https://developer.nrel.gov/docs/energy-optimization/reopt/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) for more detailed information on input parameters and default assumptions.
5
5
 
6
6
  See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-project.git) for more infomation about usage of this gem.
7
7
 
@@ -83,7 +83,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
83
83
  | ElectricityProduced:Wind:ToGrid | kWh |
84
84
  ```
85
85
 
86
- The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
86
+ The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer.nrel.gov/docs/energy-optimization/reopt/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) for more detailed information on input parameters and default assumptions.
87
87
 
88
88
  <b>Note:</b> Required attributes for a REopt run include latitude and longitude. If no utility rate is specified in your REopt Lite assumption settings, then a constant default 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).
89
89
 
data/README.md CHANGED
@@ -1,7 +1,9 @@
1
1
  # URBANopt REopt Gem
2
2
 
3
+ [![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-reopt-gem/badge.svg?branch=github-actions-coveralls)](https://coveralls.io/github/urbanopt/urbanopt-reopt-gem?branch=github-actions-coveralls)
4
+
3
5
  The **URBANopt<sup>&trade;</sup> REopt Gem** extends **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform.
4
- 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 [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
6
+ 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 [https://developer.nrel.gov/docs/energy-optimization/reopt/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) for more detailed information on input parameters and default assumptions.
5
7
 
6
8
  See the [example project](https://github.com/urbanopt/urbanopt-example-geojson-reopt-project) for more infomation about usage of this gem.
7
9
 
@@ -85,7 +87,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
85
87
  | ElectricityProduced:Wind:ToGrid | kWh |
86
88
 
87
89
 
88
- 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.
90
+ 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</StaticLink> for more detailed information on input parameters and default assumptions.
89
91
 
90
92
  <b>Note:</b> Required attributes for a REopt run include latitude and longitude. If no utility rate is specified in your REopt Lite assumption settings, then a constant default 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).
91
93
 
data/Rakefile CHANGED
@@ -20,7 +20,7 @@
20
20
  # by the same designation. Redistribution of a modified version of this software
21
21
  # (i) may not refer to the modified version by the same designation, or by any
22
22
  # confusingly similar designation, and (ii) must refer to the underlying software
23
- # originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
23
+ # originally provided by Alliance as "URBANopt". Except to comply with the foregoing,
24
24
  # the term “URBANopt”, or any confusingly similar designation may not be used to
25
25
  # refer to any modified version of this software or any modified version of the
26
26
  # underlying software originally provided by Alliance without the prior written
data/developer_nrel_key.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
data/doc_templates/LICENSE.md CHANGED
@@ -1,27 +1,27 @@
1
- URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
1
+ URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
2
2
  contributors. All rights reserved.
3
3
 
4
- Redistribution and use in source and binary forms, with or without modification,
4
+ Redistribution and use in source and binary forms, with or without modification,
5
5
  are permitted provided that the following conditions are met:
6
6
 
7
- Redistributions of source code must retain the above copyright notice, this list
7
+ Redistributions of source code must retain the above copyright notice, this list
8
8
  of conditions and the following disclaimer.
9
9
 
10
- Redistributions in binary form must reproduce the above copyright notice, this
11
- list of conditions and the following disclaimer in the documentation and/or other
10
+ Redistributions in binary form must reproduce the above copyright notice, this
11
+ list of conditions and the following disclaimer in the documentation and/or other
12
12
  materials provided with the distribution.
13
-
14
- Neither the name of the copyright holder nor the names of its contributors may be
15
- used to endorse or promote products derived from this software without specific
13
+
14
+ Neither the name of the copyright holder nor the names of its contributors may be
15
+ used to endorse or promote products derived from this software without specific
16
16
  prior written permission.
17
17
 
18
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21
- IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22
- INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23
- BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25
- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26
- OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
18
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21
+ IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22
+ INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23
+ BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26
+ OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27
27
  OF THE POSSIBILITY OF SUCH DAMAGE.
data/doc_templates/copyright_erb.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  <%
2
2
  # *********************************************************************************
3
- # URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
3
+ # URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
4
4
  # contributors. All rights reserved.
5
5
  #
6
6
  # Redistribution and use in source and binary forms, with or without modification,
@@ -28,4 +28,4 @@
28
28
  # OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29
29
  # OF THE POSSIBILITY OF SUCH DAMAGE.
30
30
  # *********************************************************************************
31
- %>
31
+ %>
data/doc_templates/copyright_js.txt CHANGED
@@ -1,4 +1,4 @@
1
1
  /* @preserve
2
- * URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
2
+ * URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
3
3
  * Use of this source code is governed by the BSD 3-Clause license.
4
- */
4
+ */
data/doc_templates/copyright_ruby.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
@@ -26,4 +26,4 @@
26
26
  # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27
27
  # OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28
28
  # OF THE POSSIBILITY OF SUCH DAMAGE.
29
- # *********************************************************************************
29
+ # *********************************************************************************
data/docs/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ### <StaticLink target="\_blank" href="rdoc/">Rdocs</StaticLink>
4
4
 
5
5
  The **URBANopt<sup>&trade;</sup> REopt Gem** extends a **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::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.
6
- 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.
6
+ 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</StaticLink> for more detailed information on input parameters and default assumptions.
7
7
 
8
8
  The REopt Gem accomplishes three basic functions (described more below in the _Functionality_ section):
9
9
 
@@ -99,7 +99,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
99
99
  | ElectricityProduced:Wind:ToGrid | kWh |
100
100
 
101
101
 
102
- 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.
102
+ 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</StaticLink> for more detailed information on input parameters and default assumptions.
103
103
 
104
104
  <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).
105
105