urbanopt-reporting 0.2.0 → 0.2.1

data/lib/urbanopt/reporting/default_reports/schema/scenario_schema.json

@@ -263,69 +263,69 @@
 				"end_date": {
 					"$ref": "#/definitions/Date"
 				},
-				"total_site_energy": {
-					"description": "Total energy used on site, does not include generation (kBtu)",
+				"total_site_energy_kwh": {
+					"description": "Total energy used on site, does not include generation (kWh)",
 					"type": "number"
 				},
-				"total_source_energy": {
-					"description": "Total source energy used, does not include generation (kBtu)",
+				"total_source_energy_kwh": {
+					"description": "Total source energy used, does not include generation (kWh)",
 					"type": "number"
 				},
-				"net_site_energy": {
-					"description": "Net site energy (kBtu)",
+				"net_site_energy_kwh": {
+					"description": "Net site energy (kWh)",
 					"type": "number"
 				},
-				"net_source_energy": {
-					"description": "Net source energy (kBtu)",
+				"net_source_energy_kwh": {
+					"description": "Net source energy (kWh)",
 					"type": "number"
 				},
-				"total_utility_cost": {
-					"description": "Total utility cost",
+				"total_utility_cost_dollar": {
+					"description": "Total utility cost ($)",
 					"type": "number"
 				},
-				"net_utility_cost": {
-					"description": "Net utility cost for reporting period includes generation",
+				"net_utility_cost_dollar": {
+					"description": "Net utility cost for reporting period includes generation ($)",
 					"type": "number"
 				},
-				"utility_costs": {
+				"utility_costs_dollar": {
 					"type": "array",
 					"items": {
 						"$ref": "#/definitions/UtilityCost"
 					}
 				},
-				"electricity": {
+				"electricity_kwh": {
 					"description": "Sum of all electricity used, does not include electricity produced (kWh)",
 					"type": "number"
 				},
-				"natural_gas": {
-					"description": "Sum of all natural gas end uses consumption (kBtu)",
+				"natural_gas_kwh": {
+					"description": "Sum of all natural gas end uses consumption (kWh)",
 					"type": "number"
 				},
-				"additional_fuel": {
-					"description": "Sum of all additional fuel end uses consumption (kBtu)",
+				"additional_fuel_kwh": {
+					"description": "Sum of all additional fuel end uses consumption (kWh)",
 					"type": "number"
 				},
-				"district_cooling": {
-					"description": "Sum of all distric cooling end uses consumption (kBtu)",
+				"district_cooling_kwh": {
+					"description": "Sum of all distric cooling end uses consumption (kWh)",
 					"type": "number"
 				},
-				"district_heating": {
-					"description": "Sum of all distric heating end uses consumption (kBtu)",
+				"district_heating_kwh": {
+					"description": "Sum of all distric heating end uses consumption (kWh)",
 					"type": "number"
 				},
-				"water": {
+				"water_qbft": {
 					"description": "Sum of all water end uses consumption (ft^3)",
 					"type": "number"
 				},
-				"electricity_produced": {
+				"electricity_produced_kwh": {
 					"description": "Sum of all electricity produced (kWh)",
 					"type": "number"
 				},
 				"end_uses": {
 					"$ref": "#/definitions/EndUses"
 				},
-				"energy_production": {
-					"description": "Energy produced for reporting period.  Electricity reported in kWh, water in m^3, all others in kBtu.",
+				"energy_production_kwh": {
+					"description": "Energy produced for reporting period.  Water reported in m^3, all others in kWh.",
 					"type": "object",
 					"properties": {
 						"electricity_produced": {
@@ -362,25 +362,25 @@
 			"additionalProperties": false
 		},
 		"EndUses": {
-			"description": "End uses for reporting period.  Does not include energy produced. Electricity reported in kWh, water in m^3, all others in kBtu.",
+			"description": "End uses for reporting period.  Does not include energy produced. Water reported in m^3, all others in kWh.",
 			"type": "object",
 			"properties": {
-				"electricity": {
+				"electricity_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"natural_gas": {
+				"natural_gas_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"additional_fuel": {
+				"additional_fuel_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"district_cooling": {
+				"district_cooling_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"district_heating": {
+				"district_heating_kwh": {
 					"$ref": "#/definitions/EndUse"
 				},
-				"water": {
+				"water_qbft": {
 					"$ref": "#/definitions/EndUse"
 				}
 			},
@@ -546,15 +546,15 @@
 		"Location": {
 			"type": "object",
 			"properties": {
-				"latitude": {
+				"latitude_deg": {
 					"description": "latitude for the centroid of the feature (deg)",
 					"type": "number"
 				},
-				"longitude": {
+				"longitude_deg": {
 					"description": "longitude for the centroid of the feature (deg)",
 					"type": "number"
 				},
-				"surface_elevation": {
+				"surface_elevation_ft": {
 					"description": "The surface elevation (above NAVD88 datum) (ft).",
 					"type": "number"
 				},
@@ -573,27 +573,27 @@
 		"Program": {
 			"type": "object",
 			"properties": {
-				"site_area": {
+				"site_area_sqft": {
 					"description": "Area of the entire site or lot (ft^2)",
 					"type": "number"
 				},
-				"floor_area": {
+				"floor_area_sqft": {
 					"description": "Building gross floor area (ft^2)",
 					"type": "number"
 				},
-				"conditioned_area": {
+				"conditioned_area_sqft": {
 					"description": "Building conditioned floor area (ft^2)",
 					"type": "number"
 				},
-				"unconditioned_area": {
+				"unconditioned_area_sqft": {
 					"description": "Building unconditioned floor area (ft^2)",
 					"type": "number"
 				},
-				"footprint_area": {
+				"footprint_area_sqft": {
 					"description": "Building floorprint area (ft^2)",
 					"type": "number"
 				},
-				"maximum_roof_height": {
+				"maximum_roof_height_ft": {
 					"description": "Maximum height of the roof relative to surface elevation (ft)",
 					"type": "number"
 				},
@@ -605,7 +605,7 @@
 					"description": "The maximum number of building stories above ground",
 					"type": "number"
 				},
-				"parking_area": {
+				"parking_area_sqft": {
 					"description": "Parking gross area (ft^2)",
 					"type": "number"
 				},
@@ -617,11 +617,11 @@
 					"description": "Number of parking spaces with electric vehicle charging",
 					"type": "number"
 				},
-				"parking_footprint_area": {
+				"parking_footprint_area_sqft": {
 					"description": "Parking floorprint area (ft^2)",
 					"type": "number"
 				},
-				"maximum_parking_height": {
+				"maximum_parking_height_ft": {
 					"description": "Maximum height of the parking structure relative to surface elevation (ft)",
 					"type": "number"
 				},
@@ -643,84 +643,84 @@
 						"$ref": "#/definitions/BuildingType"
 					}
 				},
-				"window_area": {
+				"window_area_sqft": {
 					"description": "Exterior windows gross area (ft^2)",
 					"type": "object",
 					"properties": {
-						"north_window_area": {
+						"north_window_area_sqft": {
 							"type": "number"
 						},
-						"south_window_area": {
+						"south_window_area_sqft": {
 							"type": "number"
 						},
-						"east_window_area": {
+						"east_window_area_sqft": {
 							"type": "number"
 						},
-						"west_window_area": {
+						"west_window_area_sqft": {
 							"type": "number"
 						},
-						"total_window_area": {
+						"total_window_area_sqft": {
 							"type": "number"
 						}
 					},
 					"required": [
-						"total_window_area"
+						"total_window_area_sqft"
 					],
 					"additionalProperties": false
 				},
-				"wall_area": {
+				"wall_area_sqft": {
 					"description": "exterior walls gross area (ft^2)",
 					"type": "object",
 					"properties": {
-						"north_wall_area": {
+						"north_wall_area_sqft": {
 							"type": "number"
 						},
-						"south_wall_area": {
+						"south_wall_area_sqft": {
 							"type": "number"
 						},
-						"east_wall_area": {
+						"east_wall_area_sqft": {
 							"type": "number"
 						},
-						"west_wall_area": {
+						"west_wall_area_sqft": {
 							"type": "number"
 						},
-						"total_wall_area": {
+						"total_wall_area_sqft": {
 							"type": "number"
 						}
 					},
 					"required": [
-						"north_wall_area",
-						"south_wall_area",
-						"east_wall_area",
-						"west_wall_area",
-						"total_wall_area"
+						"north_wall_area_sqft",
+						"south_wall_area_sqft",
+						"east_wall_area_sqft",
+						"west_wall_area_sqft",
+						"total_wall_area_sqft"
 					],
 					"additionalProperties": false
 				},
-				"roof_area": {
+				"roof_area_sqft": {
 					"type": "object",
 					"properties": {
-						"equipment_roof_area": {
+						"equipment_roof_area_sqft": {
 							"type": "number"
 						},
-						"photovoltaic_roof_area": {
+						"photovoltaic_roof_area_sqft": {
 							"type": "number"
 						},
-						"available_roof_area": {
+						"available_roof_area_sqft": {
 							"description": "gross roof area (ft^2)",
 							"type": "number"
 						},
-						"total_roof_area": {
+						"total_roof_area_sqft": {
 							"description": "Exterior roofs gross area (ft^2)",
 							"type": "number"
 						}
 					},
 					"required": [
-						"total_roof_area"
+						"total_roof_area_sqft"
 					],
 					"additionalProperties": false
 				},
-				"orientation": {
+				"orientation_deg": {
 					"description": "Rotation of longest axis from East-West,about up axis (deg)",
 					"type": "number"
 				},
@@ -728,22 +728,22 @@
 					"description": "Ratio of longest to shortest axis",
 					"type": "number"
 				},
-				"total_construction_cost": {
+				"total_construction_cost_dollar": {
 					"description": "total construction cost calculated from the defined cost per floor area ($)",
 					"type": "number"
 				}
 			},
 			"required": [
-				"floor_area",
-				"conditioned_area",
-				"unconditioned_area",
-				"footprint_area",
-				"maximum_roof_height",
+				"floor_area_sqft",
+				"conditioned_area_sqft",
+				"unconditioned_area_sqft",
+				"footprint_area_sqft",
+				"maximum_roof_height_ft",
 				"number_of_residential_units",
 				"building_types",
-				"window_area",
-				"wall_area",
-				"roof_area"
+				"window_area_sqft",
+				"wall_area_sqft",
+				"roof_area_sqft"
 			],
 			"additionalProperties": false
 		},
@@ -873,4 +873,4 @@
 			}
 		}
 	}
-}
+}

data/lib/urbanopt/reporting/default_reports/thermal_storage.rb

@@ -42,17 +42,17 @@ module URBANopt
         ##
         # _Float_ - Total ice storage capacity on central plant loop in kWh
         #
-        attr_accessor :its_size
+        attr_accessor :its_size_kwh
 
         # _Float_ - Total ice storage capacity distributed to packaged systems in kWh
         #
-        attr_accessor :ptes_size
+        attr_accessor :ptes_size_kwh
 
         def initialize(hash = {})
           hash.delete_if { |k, v| v.nil? }
 
-          @its_size = hash[:its_size]
-          @ptes_size = hash[:ptes_size]
+          @its_size = hash[:its_size_kwh]
+          @ptes_size = hash[:ptes_size_kwh]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -67,8 +67,8 @@ module URBANopt
         ##
         def defaults
           hash = {}
-          hash[:its_size] = nil
-          hash[:ptes_size] = nil
+          hash[:its_size_kwh] = nil
+          hash[:ptes_size_kwh] = nil
 
           return hash
         end
@@ -78,8 +78,8 @@ module URBANopt
         ##
         def to_hash
           result = {}
-          result[:its_size] = @its_size if @its_size
-          result[:ptes_size] = @ptes_size if @ptes_size
+          result[:its_size_kwh] = @its_size_kwh if @its_size_kwh
+          result[:ptes_size_kwh] = @ptes_size_kwh if @ptes_size_kwh
 
           return result
         end
@@ -100,8 +100,8 @@ module URBANopt
         # Merge thermal storage
         ##
         def self.merge_thermal_storage(existing_tes, new_tes)
-          existing_tes.its_size = add_values(existing_tes.its_size, new_tes.its_size)
-          existing_tes.ptes_size = add_values(existing_tes.ptes_size, new_tes.ptes_size)
+          existing_tes.its_size_kwh = add_values(existing_tes.its_size_kwh, new_tes.its_size_kwh)
+          existing_tes.ptes_size_kwh = add_values(existing_tes.ptes_size_kwh, new_tes.ptes_size_kwh)
 
           return existing_tes
         end

data/lib/urbanopt/reporting/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.1'.freeze
   end
 end

data/urbanopt-reporting-gem.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Library to report URBANopt results'
   spec.description   = 'Library include scenario default reporting measure and scenario defaults reports schema and classes'
   spec.homepage      = 'https://github.com/urbanopt'
+  spec.licenses      = 'Nonstandard'
 
   # 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.
@@ -26,8 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
-
-  spec.add_dependency 'json-schema'
-  spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-extension', '~> 0.2.3'
+  spec.add_runtime_dependency 'json-schema', '~> 2.8'
+  spec.add_runtime_dependency 'json_pure', '~> 2.3'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,44 +57,44 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: openstudio-extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
 description: Library include scenario default reporting measure and scenario defaults
   reports schema and classes
 email:
@@ -103,20 +103,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
+- ".rdoc_options"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Jenkinsfile
 - LICENSE.md
+- RDOC_MAIN.md
 - README.md
 - Rakefile
+- deploy_docs.sh
 - doc_templates/LICENSE.md
 - doc_templates/README.md.erb
 - doc_templates/copyright_erb.txt
 - doc_templates/copyright_js.txt
 - doc_templates/copyright_ruby.txt
+- docs/.gitignore
+- docs/.vuepress/components/InnerJsonSchema.vue
+- docs/.vuepress/components/JsonSchema.vue
+- docs/.vuepress/components/ScenarioSchema.vue
+- docs/.vuepress/components/StaticLink.vue
+- docs/.vuepress/config.js
+- docs/.vuepress/highlight.js
+- docs/.vuepress/json-schema-deref-loader.js
+- docs/.vuepress/public/custom_rdoc_styles.css
+- docs/.vuepress/styles/palette.styl
+- docs/.vuepress/utils.js
+- docs/README.md
+- docs/package-lock.json
+- docs/package.json
+- docs/schemas/scenario-schema.md
 - lib/measures/.rubocop.yml
 - lib/measures/default_feature_reports/LICENSE.md
 - lib/measures/default_feature_reports/README.md
@@ -152,7 +173,8 @@ files:
 - lib/urbanopt/reporting/version.rb
 - urbanopt-reporting-gem.gemspec
 homepage: https://github.com/urbanopt
-licenses: []
+licenses:
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: []