urbanopt-cli 0.8.0 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (20) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -0
  3. data/CHANGELOG.md +7 -0
  4. data/CMakeLists.txt +7 -7
  5. data/FindOpenStudioSDK.cmake +6 -6
  6. data/README.md +3 -3
  7. data/example_files/Gemfile +6 -7
  8. data/example_files/example_project.json +9 -14
  9. data/example_files/example_project_combined.json +10 -22
  10. data/example_files/example_project_with_PV.json +8 -1
  11. data/example_files/example_project_with_electric_network.json +8 -1
  12. data/example_files/example_project_with_streets.json +9 -2
  13. data/example_files/mappers/Baseline.rb +283 -256
  14. data/example_files/validation_schema.yaml +11 -11
  15. data/example_files/visualization/input_visualization_feature.html +246 -9
  16. data/example_files/visualization/input_visualization_scenario.html +119 -11
  17. data/lib/uo_cli/version.rb +1 -1
  18. data/lib/uo_cli.rb +58 -49
  19. data/uo_cli.gemspec +2 -2
  20. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 72816c1959442fab9221c0130801411914572766fe69fccddbae887d6a7305f6
4
- data.tar.gz: 4506928bd069aeebddb7a3bc5b9495b4fd74d64696888c89b001d1a9f2c01b14
3
+ metadata.gz: 2cfc76f36d83740edb23d5467b70a0f91f705b92b9e4404b0b4040291680a723
4
+ data.tar.gz: 8f0775b5b8a3342cc4a59e0644dfbbaf0da3ca3f769cacdbb793d18f61c0f061
5
5
  SHA512:
6
- metadata.gz: ea6a2edbbd1b8e6c2704cb7a0dce47163d07983fbc0e337cf05b7f63851f841d5ef4a1baed0be86be91b08c6ace00f3f00f63f696f971263a2ea034d6b449e27
7
- data.tar.gz: 86d471d9b2f0d66b0738c16c5715f296bf089642132ccb8ad89f9f21ba13f1b99e08867808a421aee2eb5fb6009757d6ce6c272fcb0c67534e33a03ade30fc1a
6
+ metadata.gz: 5c095dbcdfd3515663dfa8dc521ca1905ff33d19b1289d9eb869b9cce7d21e21c037c1d22dc464f4b35c2e75427910fd2640e5f89deef7991629156102990823
7
+ data.tar.gz: ddfa5de59cc47cedf5226bdfa1b5d5090ab49328faec6e79f757fcb267bd9fdc358dfa4ece1e1a82dca87bfd07b7b8ff92700fd749c1e39e613dc6eb733586f3
data/.gitignore CHANGED
@@ -27,3 +27,6 @@ spec/test_directory_*
27
27
 
28
28
  Gemfile.lock
29
29
  .rubocop*
30
+
31
+ # python dependencies
32
+ example_files/python_deps
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## Version 0.8.1
4
+ Date Range: 05/14/22 - 06/28/22:
5
+
6
+ - Fixed [#343]( https://github.com/urbanopt/urbanopt-cli/issues/343 ), Carbon Emission Reporting
7
+ - Fixed [#329]( https://github.com/urbanopt/urbanopt-cli/issues/329 ), Better error messages for missing modelica files
8
+ - Fixed [#349]( https://github.com/urbanopt/urbanopt-cli/issues/349 ), num_parallel bug
9
+
3
10
  ## Version 0.8.0
4
11
 
5
12
  Date Range: 12/22/21 - 05/13/22:
data/CMakeLists.txt CHANGED
@@ -1,7 +1,7 @@
1
1
  cmake_minimum_required(VERSION 3.10.2)
2
2
  cmake_policy(SET CMP0048 NEW)
3
3
 
4
- project(URBANoptCLI VERSION 0.7.1)
4
+ project(URBANoptCLI VERSION 0.8.0)
5
5
 
6
6
  include(FindOpenStudioSDK.cmake)
7
7
 
@@ -89,16 +89,16 @@ option(BUILD_PACKAGE "Build package" OFF)
89
89
  # need to update the MD5sum for each platform and url below
90
90
  if(UNIX)
91
91
  if(APPLE)
92
- set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-darwin.tar.gz")
93
- set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9c09ef89a66acff72377fa052542f0df")
92
+ set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-darwin.tar.gz")
93
+ set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "9dea01c3a9664818a15ad34a5d37a155")
94
94
  else()
95
- set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-linux.tar.gz")
96
- set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "6094f724a143023c19ab28b65d26094d")
95
+ set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-linux.tar.gz")
96
+ set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "84678cac20979c63913c8e4f99f30e0e")
97
97
  endif()
98
98
  elseif(WIN32)
99
99
  if(CMAKE_CL_64)
100
- set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20211227-windows.tar.gz")
101
- set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "e1e0b44997dfd188996ef3bc5aa31388")
100
+ set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20220520-windows.tar.gz")
101
+ set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "e31a7f7c12bde79046e18f9d2a23f105")
102
102
  endif()
103
103
  endif()
104
104
 
data/FindOpenStudioSDK.cmake CHANGED
@@ -1,5 +1,5 @@
1
1
  set(OPENSTUDIO_VERSION_MAJOR 3)
2
- set(OPENSTUDIO_VERSION_MINOR 3)
2
+ set(OPENSTUDIO_VERSION_MINOR 4)
3
3
  set(OPENSTUDIO_VERSION_PATCH 0)
4
4
  set(OPENSTUDIO_VERSION "${OPENSTUDIO_VERSION_MAJOR}.${OPENSTUDIO_VERSION_MINOR}.${OPENSTUDIO_VERSION_PATCH}")
5
5
 
@@ -16,23 +16,23 @@ else()
16
16
  set(OPENSTUDIO_BASELINK "https://openstudio-builds.s3.amazonaws.com/${OPENSTUDIO_VERSION}"
17
17
  CACHE STRING "Base link to where the openstudio archives are hosted" FORCE)
18
18
 
19
- set(OPENSTUDIO_VERSION_SHA "+ad235ff36e")
19
+ set(OPENSTUDIO_VERSION_SHA "+4bd816f785")
20
20
 
21
21
  if(APPLE)
22
- set(OPENSTUDIO_EXPECTED_HASH 77c2bf77f07dc2e2af7658df55940c49)
22
+ set(OPENSTUDIO_EXPECTED_HASH 5a1e5fdfc61a879a9d72dcf625a83e65)
23
23
  set(OPENSTUDIO_PLATFORM "Darwin")
24
24
  set(OPENSTUDIO_EXT "tar.gz")
25
25
  elseif(UNIX)
26
26
  if(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
27
- set(OPENSTUDIO_EXPECTED_HASH 7fca6ef73399fdb21cde01aca4223d7c)
27
+ set(OPENSTUDIO_EXPECTED_HASH 1922de95bb3e196f1c719400ce58871c)
28
28
  set(OPENSTUDIO_PLATFORM "Ubuntu-20.04")
29
29
  else() # Assumes 18.04
30
- set(OPENSTUDIO_EXPECTED_HASH 24858ac666a3d2fc40d0cff7b4f444b9)
30
+ set(OPENSTUDIO_EXPECTED_HASH 44a837fa96fe2ce1a883492a3a1cae09)
31
31
  set(OPENSTUDIO_PLATFORM "Ubuntu-18.04")
32
32
  endif()
33
33
  set(OPENSTUDIO_EXT "tar.gz")
34
34
  elseif(WIN32)
35
- set(OPENSTUDIO_EXPECTED_HASH f01ddb50a7ce1f4461e1919350e7c629)
35
+ set(OPENSTUDIO_EXPECTED_HASH 9adffb37a62721ec51a33ce97533e956)
36
36
  set(OPENSTUDIO_PLATFORM "Windows")
37
37
  set(OPENSTUDIO_EXT "tar.gz")
38
38
  endif()
data/README.md CHANGED
@@ -30,7 +30,7 @@ Below are installation instructions for each platform.
30
30
 
31
31
  ### Linux (Ubuntu 18.04)
32
32
 
33
- Download the .deb package.
33
+ Download the [.deb package](https://docs.urbanopt.net/installation/linux.html#install-with-the-urbanopt-installer).
34
34
 
35
35
  ```terminal
36
36
  sudo apt update
@@ -52,7 +52,7 @@ When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment
52
52
 
53
53
  ### Mac OSX (>= 10.12)
54
54
 
55
- Download the .dmg package.
55
+ Download the [.dmg package](https://docs.urbanopt.net/installation/mac.html#install-with-the-urbanopt-installer).
56
56
 
57
57
  Use the GUI installer and choose a directory to install. Once installed, open a terminal and run the provided setup script.
58
58
  The `setup-env.sh` generates env variables and stores them in a file `.env_uo.sh` in your home directory.
@@ -66,7 +66,7 @@ When launching new shell terminals run `. ~/.env_uo.s` to setup the environment.
66
66
 
67
67
  ### Windows (64-bit Windows 7 – 10)
68
68
 
69
- Download the .exe installer.
69
+ Download the [.exe installer](https://docs.urbanopt.net/installation/windows.html#install-with-the-urbanopt-installer).
70
70
 
71
71
  Use the GUI installer and choose a directory to install. Once installed, open a terminal (Powershell, Windows CMD and GitBash are supported) and run the provided setup script for that shell (below are the setup scripts for each respective shell environment).
72
72
 
data/example_files/Gemfile CHANGED
@@ -31,7 +31,7 @@ if allow_local && File.exist?('../openstudio-common-measures-gem')
31
31
  elsif allow_local
32
32
  gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
33
33
  else
34
- gem 'openstudio-common-measures', '~> 0.6.0'
34
+ gem 'openstudio-common-measures', '~> 0.6.1'
35
35
  end
36
36
 
37
37
  if allow_local && File.exist?('../openstudio-model-articulation-gem')
@@ -67,22 +67,21 @@ else
67
67
  end
68
68
 
69
69
 
70
- # TODO : Uncomment to revert changes once gem is released
71
- if allow_local && File.exists?('../urbanopt-geojson-gem')
72
- gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
70
+ if allow_local && File.exist?('../urbanopt-geojson-gem')
71
+ gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
73
72
  elsif allow_local
74
73
  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
75
74
  else
76
- gem 'urbanopt-geojson', '~> 0.8.0'
75
+ gem 'urbanopt-geojson', '~> 0.8.1'
77
76
  end
78
77
 
79
78
  # NEVER put SCENARIO-GEM in this file...it will make all simulations fail due to the sqlite dependency
80
79
  # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
81
80
 
82
81
  if allow_local && File.exist?('../urbanopt-reporting-gem')
83
- gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
82
+ gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
84
83
  elsif allow_local
85
84
  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
86
85
  else
87
- gem 'urbanopt-reporting', '~> 0.6.0'
86
+ gem 'urbanopt-reporting', '~> 0.6.1'
88
87
  end
data/example_files/example_project.json CHANGED
@@ -13,7 +13,14 @@
13
13
  "surface_elevation": null,
14
14
  "tariff_filename": null,
15
15
  "timesteps_per_hour": 1,
16
- "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw"
16
+ "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
17
+ "emissions": true,
18
+ "electricity_emissions_future_subregion": "NYSTc",
19
+ "electricity_emissions_hourly_historical_subregion": "New York",
20
+ "electricity_emissions_annual_historical_subregion": "NYCW",
21
+ "electricity_emissions_future_year": "2030",
22
+ "electricity_emissions_hourly_historical_year": "2019",
23
+ "electricity_emissions_annual_historical_year": "2019"
17
24
  },
18
25
  "scenarios": [
19
26
  {
@@ -164,10 +171,6 @@
164
171
  "floor_area": 125631,
165
172
  "footprint_area": 41877,
166
173
  "number_of_stories": 3,
167
- "emissions" : true,
168
- "emissions_future_year": "2020",
169
- "emissions_hourly_historical_year": "2019",
170
- "emissions_annual_historical_year": "2019",
171
174
  "ev_charging": true,
172
175
  "ev_charging_station_type": "Typical Public"
173
176
  },
@@ -253,7 +256,6 @@
253
256
  "floor_area": 8804,
254
257
  "footprint_area": 8804,
255
258
  "number_of_stories": 1,
256
- "emissions" : false,
257
259
  "ev_charging": true,
258
260
  "ev_charging_station_type": "Typical Work"
259
261
  },
@@ -337,14 +339,7 @@
337
339
  "building_type": "Office",
338
340
  "system_type": "VAV district chilled water with district hot water reheat",
339
341
  "number_of_stories": 6,
340
- "detailed_model_filename": "7.osm",
341
- "emissions" : true,
342
- "emissions_future_subregion": "RMPAc",
343
- "emissions_hourly_historical_subregion": "Rocky Mountains",
344
- "emissions_annual_historical_subregion": "RMPA",
345
- "emissions_future_year": "2020",
346
- "emissions_hourly_historical_year": "2019",
347
- "emissions_annual_historical_year": "2019"
342
+ "detailed_model_filename": "7.osm"
348
343
  },
349
344
  "geometry": {
350
345
  "type": "Polygon",
data/example_files/example_project_combined.json CHANGED
@@ -12,7 +12,14 @@
12
12
  "begin_date": "2017-01-01T07:00:00.000Z",
13
13
  "end_date": "2017-12-31T07:00:00.000Z",
14
14
  "timesteps_per_hour": 1,
15
- "default_template": "90.1-2013"
15
+ "default_template": "90.1-2013",
16
+ "emissions": true,
17
+ "electricity_emissions_future_subregion": "NYSTc",
18
+ "electricity_emissions_hourly_historical_subregion": "New York",
19
+ "electricity_emissions_annual_historical_subregion": "NYCW",
20
+ "electricity_emissions_future_year": "2030",
21
+ "electricity_emissions_hourly_historical_year": "2019",
22
+ "electricity_emissions_annual_historical_year": "2019"
16
23
  },
17
24
  "features": [
18
25
  {
@@ -157,10 +164,6 @@
157
164
  "weekday_duration": "11:30",
158
165
  "weekend_start_time": "11:00",
159
166
  "weekend_duration": "11:30",
160
- "emissions" : true,
161
- "emissions_future_year": "2020",
162
- "emissions_hourly_historical_year": "2019",
163
- "emissions_annual_historical_year": "2019",
164
167
  "ev_charging": true,
165
168
  "ev_charging_station_type": "Typical Public"
166
169
  },
@@ -249,7 +252,6 @@
249
252
  "number_of_stories": 1,
250
253
  "weekday_start_time": "06:00",
251
254
  "weekday_duration": "16:00",
252
- "emissions" : false,
253
255
  "ev_charging": true,
254
256
  "ev_charging_station_type": "Typical Work"
255
257
  },
@@ -329,14 +331,7 @@
329
331
  "type": "Building",
330
332
  "building_type": "Office",
331
333
  "number_of_stories": 6,
332
- "detailed_model_filename": "7.osm",
333
- "emissions" : true,
334
- "emissions_future_subregion": "RMPAc",
335
- "emissions_hourly_historical_subregion": "Rocky Mountains",
336
- "emissions_annual_historical_subregion": "RMPA",
337
- "emissions_future_year": "2020",
338
- "emissions_hourly_historical_year": "2019",
339
- "emissions_annual_historical_year": "2019"
334
+ "detailed_model_filename": "7.osm"
340
335
  },
341
336
  "geometry": {
342
337
  "type": "Polygon",
@@ -655,14 +650,7 @@
655
650
  "system_type": "Residential - furnace and central air conditioner",
656
651
  "heating_system_fuel_type": "natural gas",
657
652
  "onsite_parking_fraction": 1,
658
- "template": "Residential IECC 2015 - Customizable Template Sep 2020",
659
- "emissions" : true,
660
- "emissions_future_subregion": "RMPAc",
661
- "emissions_hourly_historical_subregion": "Rocky Mountains",
662
- "emissions_annual_historical_subregion": "RMPA",
663
- "emissions_future_year": "2020",
664
- "emissions_hourly_historical_year": "2019",
665
- "emissions_annual_historical_year": "2019"
653
+ "template": "Residential IECC 2015 - Customizable Template Sep 2020"
666
654
  },
667
655
  "geometry": {
668
656
  "type": "Polygon",
data/example_files/example_project_with_PV.json CHANGED
@@ -13,7 +13,14 @@
13
13
  "end_date": "2017-12-31T07:00:00.000Z",
14
14
  "timesteps_per_hour": 1,
15
15
  "default_template": "90.1-2013",
16
- "tariff_filename": null
16
+ "tariff_filename": null,
17
+ "emissions": true,
18
+ "electricity_emissions_future_subregion": "NYSTc",
19
+ "electricity_emissions_hourly_historical_subregion": "New York",
20
+ "electricity_emissions_annual_historical_subregion": "NYCW",
21
+ "electricity_emissions_future_year": "2030",
22
+ "electricity_emissions_hourly_historical_year": "2019",
23
+ "electricity_emissions_annual_historical_year": "2019"
17
24
  },
18
25
  "features": [
19
26
  {
data/example_files/example_project_with_electric_network.json CHANGED
@@ -13,7 +13,14 @@
13
13
  "surface_elevation": null,
14
14
  "tariff_filename": null,
15
15
  "timesteps_per_hour": 1,
16
- "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw"
16
+ "weather_filename": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
17
+ "emissions": true,
18
+ "electricity_emissions_future_subregion": "NYSTc",
19
+ "electricity_emissions_hourly_historical_subregion": "New York",
20
+ "electricity_emissions_annual_historical_subregion": "NYCW",
21
+ "electricity_emissions_future_year": "2030",
22
+ "electricity_emissions_hourly_historical_year": "2019",
23
+ "electricity_emissions_annual_historical_year": "2019"
17
24
  },
18
25
  "scenarios": [
19
26
  {
data/example_files/example_project_with_streets.json CHANGED
@@ -13,9 +13,16 @@
13
13
  "end_date": "2017-12-31T07:00:00.000Z",
14
14
  "timesteps_per_hour": 1,
15
15
  "default_template": "90.1-2013",
16
- "underground_cables_ratio": "0.9",
16
+ "underground_cables_ratio": 0.9,
17
17
  "only_lv_consumers": false,
18
- "max_number_of_lv_nodes_per_building": 1
18
+ "max_number_of_lv_nodes_per_building": 1,
19
+ "emissions": true,
20
+ "electricity_emissions_future_subregion": "NYSTc",
21
+ "electricity_emissions_hourly_historical_subregion": "New York",
22
+ "electricity_emissions_annual_historical_subregion": "NYCW",
23
+ "electricity_emissions_future_year": "2030",
24
+ "electricity_emissions_hourly_historical_year": "2019",
25
+ "electricity_emissions_annual_historical_year": "2019"
19
26
  },
20
27
  "features": [
21
28
  {