urbanopt-reporting 0.1.1 → 0.3.2

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/reporting/default_reports/schema/README.md

@@ -1,6 +1,6 @@
 # URBANopt Scenario Schema
 
-The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results.  An URBANopt Scenario describes a specific set of options to apply to each Feature in a FeatureFile (e.g. each GeoJSON Feature in an URBANopt GeoJSON File).  User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files.  A ScenarioRunner is used to perform simulations for each SimulationDir.  Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.  The [URBANopt Scenario Gem Design Document](https://docs.google.com/document/d/1ExcGuHliaSvPlrYevAJTSV8XAtTQXz_KQqH3p4iQDwg/edit) describes the gem in more detail.  The [URBANopt Example Project](https://github.com/urbanopt/urbanopt-example-project) demonstrates how to use the URBANopt Scenario Gem to perform a scenario analysis.
+The URBANopt <sup>&trade;</sup> Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results.  An URBANopt Scenario describes a specific set of options to apply to each Feature in a FeatureFile (e.g. each GeoJSON Feature in an URBANopt GeoJSON File).  User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files.  A ScenarioRunner is used to perform simulations for each SimulationDir.  Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.  The [URBANopt Scenario Gem Design Document](https://docs.google.com/document/d/1ExcGuHliaSvPlrYevAJTSV8XAtTQXz_KQqH3p4iQDwg/edit) describes the gem in more detail.  The [URBANopt Example Project](https://github.com/urbanopt/urbanopt-example-project) demonstrates how to use the URBANopt Scenario Gem to perform a scenario analysis.
 
 ## Reporting output units
 

data/lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt

@@ -2,6 +2,9 @@ Datetime
 Electricity:Facility
 ElectricityProduced:Facility
 Gas:Facility
+Propane:Facility
+FuelOil#2:Facility
+OtherFuels:Facility
 Cooling:Electricity
 Heating:Electricity
 InteriorLights:Electricity
@@ -15,6 +18,18 @@ HeatRejection:Gas
 Heating:Gas
 WaterSystems:Gas
 InteriorEquipment:Gas
+HeatRejection:Propane
+Heating:Propane
+WaterSystems:Propane
+InteriorEquipment:Propane
+HeatRejection:FuelOil#2
+Heating:FuelOil#2
+WaterSystems:FuelOil#2
+InteriorEquipment:FuelOil#2
+HeatRejection:OtherFuels
+Heating:OtherFuels
+WaterSystems:OtherFuels
+InteriorEquipment:OtherFuels
 DistrictCooling:Facility
 DistrictHeating:Facility
 District Cooling Chilled Water Rate

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

@@ -263,69 +263,77 @@
 				"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)",
+        "propane_kwh": {
+					"description": "Sum of all propane end uses consumption (kWh)",
+					"type": "number"
+        },
+        "fuel_oil_kwh": {
+					"description": "Sum of all fuel oil #2 end uses consumption (kWh)",
+					"type": "number"
+        },
+				"other_fuels_kwh": {
+					"description": "Sum of all other (fuel oil #1, diesel, gasoline, coal, steam) 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 +370,31 @@
 			"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": {
+        "propane_kwh": {
+          "$ref": "#/definitions/EndUse"
+        },
+        "fuel_oil_kwh": {
+          "$ref": "#/definitions/EndUse"
+        },
+				"other_fuels_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"
 				}
 			},
@@ -522,9 +536,11 @@
 					"enum": [
 						"Electricity",
 						"Natural Gas",
+            "Propane",
+            "Fuel Oil",
 						"District Cooling",
 						"District Heating",
-						"Additional Fuel",
+						"Other Fuels",
 						"Water"
 					]
 				},
@@ -546,15 +562,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 +589,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 +621,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 +633,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 +659,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 +744,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 +889,4 @@
 			}
 		}
 	}
-}
+}

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -61,7 +61,7 @@ module URBANopt
           @@schema ||= @@validator.schema
 
           # initialize @@logger
-          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+          @@logger ||= URBANopt::Reporting::DefaultReports.logger
         end
 
         ##

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -66,7 +66,7 @@ module URBANopt
           @@schema ||= @@validator.schema
 
           # initialize @@logger
-          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+          @@logger ||= URBANopt::Reporting::DefaultReports.logger
         end
 
         ##