urbanopt-geojson 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7613399a7562744b442496ca2e1f504ea799dcbeb53aa4f70b3515c91d9cdd00
-  data.tar.gz: d93fde6bdd9ad432bc560dc0f76ee17e5c67bd2c79be13e4521a944f6e28aa75
+  metadata.gz: 4106ba555afeedb72ee9af421850a0d26226136d64b85c60143fe9cffdab2848
+  data.tar.gz: dda42f59468fa27eb9e532f4a2e35bd0fa397ce5d929bdcda0a49f26bd701461
 SHA512:
-  metadata.gz: d07deae4e780938602afdee97570444d68c48373343437728d793ac6962bd5f50e0c2112190d05f435e6bb381ade777e3e4d563cca61a5dafa6f834d24ef35f4
-  data.tar.gz: dd481e3f4dce7716c2dd7f8f9950678d24b53bfb21a61d76459cfccdef0dde2330040b0d974d7f1782905f80538ffc012877d32e28c2fc086e76bd96c5c957ac
+  metadata.gz: 70855197e712c96b458553b469840ac6607e1d60dc255b6558470b5fc4225f5561d33b0043972e158b00625c1e257883595c3b327762d9b3cb7e747ec5d33ef5
+  data.tar.gz: 125d45fe2a4ca9641145a2625870b50bf23ef6b2e876e10e4e655adcd1c68692eaed87dd03976b7b2f7ab44c10fa671b9576d9184fd13be9b3d213053b028c19

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 # URBANopt GeoJSON Gem
 
+## Version 0.8.1
+Date Range: 05/11/22 - 06/27/22
+
+- Fixed [#233]( https://github.com//urbanopt/urbanopt-geojson-gem/pull/233 ), Emissions workflow enhancements
+
 ## Version 0.8.0
-Date Range: 11/23/21 - 05/10/21
+Date Range: 11/23/21 - 05/10/22
 - Fixed [#205]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/205 ), adding RNM result fields
 - Fixed [#206]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/206 ), Bump follow-redirects from 1.13.3 to 1.14.7 in /docs
 - Fixed [#207]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/207 ), Bump follow-redirects from 1.13.3 to 1.14.8 in /docs

data/lib/urbanopt/geojson/geo_file.rb

@@ -82,6 +82,7 @@ module URBANopt
           symbolize_names: true
         )
 
+
         # validate geojson file against schema
         geojson_errors = validate(@@geojson_schema, geojson_file)
         unless geojson_errors.empty?
@@ -91,6 +92,15 @@ module URBANopt
         # initialize @@logger
         @@logger ||= URBANopt::GeoJSON.logger
 
+        # validate project section first
+        if geojson_file.key?(:project)
+          errors = validate(@@site_schema, geojson_file[:project])
+
+          unless errors.empty?
+            raise "Project section does not adhere to schema: \n #{errors.join('\n  ')}"
+          end
+        end
+
         # validate each feature against schema
         geojson_file[:features].each do |feature|
           properties = feature[:properties]
@@ -213,12 +223,12 @@ module URBANopt
           { site: :weather_filename, feature: :weather_filename },
           { site: :tariff_filename, feature: :tariff_filename },
           { site: :emissions, feature: :emissions },
-          { site: :emissions_future_subregion, feature: :emissions_future_subregion },
-          { site: :emissions_hourly_historical_subregion, feature: :emissions_hourly_historical_subregion },
-          { site: :emissions_annual_historical_subregion, feature: :emissions_annual_historical_subregion },
-          { site: :emissions_future_year, feature: :emissions_future_year },
-          { site: :emissions_hourly_historical_year, feature: :emissions_hourly_historical_year },
-          { site: :emissions_annual_historical_year, feature: :emissions_annual_historical_year }
+          { site: :electricity_emissions_future_subregion, feature: :electricity_emissions_future_subregion },
+          { site: :electricity_emissions_hourly_historical_subregion, feature: :electricity_emissions_hourly_historical_subregion },
+          { site: :electricity_emissions_annual_historical_subregion, feature: :electricity_emissions_annual_historical_subregion },
+          { site: :electricity_emissions_future_year, feature: :electricity_emissions_future_year },
+          { site: :electricity_emissions_hourly_historical_year, feature: :electricity_emissions_hourly_historical_year },
+          { site: :electricity_emissions_annual_historical_year, feature: :electricity_emissions_annual_historical_year }
         ]
 
         add_props.each do |prop|
@@ -295,6 +305,19 @@ module URBANopt
         return result
       end
 
+      def self.get_site_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/site_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
+      end
+
       def self.get_electrical_connector_schema(strict)
         result = nil
         File.open(File.dirname(__FILE__) + '/schema/electrical_connector_properties.json') do |f|
@@ -356,6 +379,7 @@ module URBANopt
       @@electrical_junction_schema = get_electrical_junction_schema(strict)
       @@thermal_connector_schema = get_thermal_connector_schema(strict)
       @@thermal_junction_schema = get_thermal_junction_schema(strict)
+      @@site_schema = get_site_schema(strict)
     end
   end
 end

data/lib/urbanopt/geojson/schema/building_properties.json

@@ -283,141 +283,16 @@
 		"ev_curtailment_frac": {
 			"description": "Fraction between 0 and 1 that denotes curtailment of EV charging load to better align EV charging with expected energy production from a solar PV system",
 			"type": "number"
-		},
-		"emissions": {
-			"description": "Should be set to true to calculate emissions for the associated building.",
-			"type": "boolean"
-		},
-		"emissions_future_subregion": {
-			"description": "Future subregion. Options: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc",
-			"type": "string",
-			"enum": [
-				"AZNMc",
-				"CAMXc",
-				"ERCTc",
-				"FRCCc",
-				"MROEc",
-				"MROWc",
-				"NEWEc",
-				"NWPPc",
-				"NYSTc",
-				"RFCEc",
-				"RFCMc",
-				"RFCWc",
-				"RMPAc",
-				"SPNOc",
-				"SPSOc",
-				"SRMVc",
-				"SRMWc",
-				"SRSOc",
-				"SRTVc",
-				"SRVCc"
-			]
-		},
-		"emissions_hourly_historical_subregion": {
-			"description": "Historical hourly subregion. Options: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas",
-			"type": "string",
-			"enum": [
-				"California",
-				"Carolinas",
-				"Central",
-				"Florida",
-				"Mid-Atlantic",
-				"Midwest",
-				"New England",
-				"New York",
-				"Northwest",
-				"Rocky Mountains",
-				"Southeast",
-				"Southwest",
-				"Tennessee",
-				"Texas"
-			]
-		},
-		"emissions_annual_historical_subregion": {
-			"description": "Historical annual subregion. Options: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC",
-			"type": "string",
-			"enum": [
-				"AKGD",
-				"AKMS",
-				"AZNM",
-				"CAMX",
-				"ERCT",
-				"FRCC",
-				"HIMS",
-				"HIOA",
-				"MROE",
-				"MROW",
-				"NEWE",
-				"NWPP",
-				"NYCW",
-				"NYLI",
-				"NYUP",
-				"RFCE",
-				"RFCM",
-				"RFCW",
-				"RMPA",
-				"SPNO",
-				"SPSO",
-				"SRMV",
-				"SRMW",
-				"SRSO",
-				"SRTV",
-				"SRVC"
-			]
-		},
-		"emissions_future_year": {
-			"description": "Future Year. Options: 2020 to 2050 in two year increments",
-			"type": "string",
-			"enum": [
-				"2020",
-				"2022",
-				"2024",
-				"2026",
-				"2028",
-				"2030",
-				"2032",
-				"2034",
-				"2036",
-				"2038",
-				"2040",
-				"2042",
-				"2044",
-				"2046",
-				"2048",
-				"2050"
-			]
-		},
-		"emissions_hourly_historical_year": {
-			"description": "Hourly Historical Year. Options: 2019.",
-			"type": "string",
-			"enum": [
-				"2019"
-			]
-		},
-		"emissions_annual_historical_year": {
-			"description": "Annual Historical Year. Options: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.",
-			"type": "string",
-			"enum": [
-				"2007",
-				"2009",
-				"2010",
-				"2012",
-				"2014",
-				"2016",
-				"2018",
-				"2019"
-			]
 		}
 	},
- "required": [
-		"building_type",
-		"floor_area",
-		"footprint_area",
+	"required": [
 		"id",
+		"type",
 		"name",
+		"floor_area",
 		"number_of_stories",
-		"type"
+		"footprint_area",
+		"building_type"
 	],
 	"definitions": {
 		"buildingType": {
@@ -640,4 +515,4 @@
 			]
 		}
 	}
-}
+}

data/lib/urbanopt/geojson/schema/site_properties.json

@@ -1,6 +1,6 @@
 {
 	"$schema": "http://json-schema.org/draft-04/schema#",
-	"id": "http://json-schema.org/openstudio-urban-modeling/taxlot_properties.json#",
+	"id": "http://json-schema.org/openstudio-urban-modeling/site_properties.json#",
 	"title": "URBANopt Site",
 	"description": "Schema for an URBANopt Site object",
 	"type": "object",
@@ -35,11 +35,11 @@
 		},
 		"surface_elevation": {
 			"description": "The surface elevation (above NAVD88 datum) of the project (ft).  ",
-			"type": "number"
+			"type": ["number", "null"]
 		},
 		"import_surrounding_buildings_as_shading": {
 			"description": "If true, import geometry from surrounding buildings when performing energy calculations.",
-			"type": "boolean"
+			"type": ["boolean", "null"]
 		},
 		"timesteps_per_hour": {
 			"description": "Number of timesteps per hour for energy simulations.",
@@ -57,11 +57,11 @@
 		},
 		"climate_zone": {
 			"description": "ASHRAE 169 climate zone.",
-			"type": "string"
+			"type": ["string", "null"]
 		},
 		"cec_climate_zone": {
 			"description": "CEC Title24 climate zone.",
-			"type": "string"
+			"type": ["string", "null"]
 		},
 		"default_template": {
 			"description": "Default OpenStudio Standards template.",
@@ -73,7 +73,7 @@
 		},
 		"tariff_filename": {
 			"description": "Name of utility tariff file in IDF or URDB format.",
-			"type": "string"
+			"type": ["string", "null"]
 		},
 		"underground_cables_ratio": {
 			"description": "Ratio of overall cables that are underground vs. overhead for RNM analysis.",
@@ -88,40 +88,132 @@
 			"type": "number"
 		},
 		"emissions": {
-			"description": "Should be set to true to calculate emissions for the associated building.",
+			"description": "Should be set to true to calculate electricity emissions for the associated building.",
 			"type": "boolean"
 		},
-		"emissions_future_subregion": {
-			"description": "Future subregion. Options are: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc",
-			"type": "string"
-		},
-		"emissions_hourly_historical_subregion": {
-			"description": "Historical hourly subregion. Options are: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas",
-			"type": "string"
-		},
-		"emissions_annual_historical_subregion": {
-			"description": "Historical annual subregion. Options are: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC",
-			"type": "string"
-		},
-		"emissions_future_year": {
-			"description": "Future Year. Options are: 2020 to 2050 in two year increments",
-			"type": "string"
-		},
-		"emissions_hourly_historical_year": {
-			"description": "Hourly Historical Year. Options are: 2019.",
-			"type": "string"
-		},
-		"emissions_annual_historical_year": {
-			"description": "Annual Historical Year. Options are: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.",
-			"type": "string"
-		},
-		"user_data": {
-			"description": "Arbitrary user data"
+		"electricity_emissions_future_subregion": {
+			"description": "Future subregion for electricity emssions. Options: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc",
+			"type": "string",
+			"enum": [
+				"AZNMc",
+				"CAMXc",
+				"ERCTc",
+				"FRCCc",
+				"MROEc",
+				"MROWc",
+				"NEWEc",
+				"NWPPc",
+				"NYSTc",
+				"RFCEc",
+				"RFCMc",
+				"RFCWc",
+				"RMPAc",
+				"SPNOc",
+				"SPSOc",
+				"SRMVc",
+				"SRMWc",
+				"SRSOc",
+				"SRTVc",
+				"SRVCc"
+			]
+		},
+		"electricity_emissions_hourly_historical_subregion": {
+			"description": "Historical hourly subregion for electricity emissions. Options: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas",
+			"type": "string",
+			"enum": [
+				"California",
+				"Carolinas",
+				"Central",
+				"Florida",
+				"Mid-Atlantic",
+				"Midwest",
+				"New England",
+				"New York",
+				"Northwest",
+				"Rocky Mountains",
+				"Southeast",
+				"Southwest",
+				"Tennessee",
+				"Texas"
+			]
+		},
+		"electricity_emissions_annual_historical_subregion": {
+			"description": "Historical annual subregion for electricity emissions. Options: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC",
+			"type": "string",
+			"enum": [
+				"AKGD",
+				"AKMS",
+				"AZNM",
+				"CAMX",
+				"ERCT",
+				"FRCC",
+				"HIMS",
+				"HIOA",
+				"MROE",
+				"MROW",
+				"NEWE",
+				"NWPP",
+				"NYCW",
+				"NYLI",
+				"NYUP",
+				"RFCE",
+				"RFCM",
+				"RFCW",
+				"RMPA",
+				"SPNO",
+				"SPSO",
+				"SRMV",
+				"SRMW",
+				"SRSO",
+				"SRTV",
+				"SRVC"
+			]
+		},
+		"electricity_emissions_future_year": {
+			"description": "Future Year for electricity emissions. Options: 2020 to 2050 in two year increments",
+			"type": "string",
+			"enum": [
+				"2020",
+				"2022",
+				"2024",
+				"2026",
+				"2028",
+				"2030",
+				"2032",
+				"2034",
+				"2036",
+				"2038",
+				"2040",
+				"2042",
+				"2044",
+				"2046",
+				"2048",
+				"2050"
+			]
+		},
+		"electricity_emissions_hourly_historical_year": {
+			"description": "Hourly Historical Year for elecrtricity emissions. Options: 2019.",
+			"type": "string",
+			"enum": [
+				"2019"
+			]
+		},
+		"electricity_emissions_annual_historical_year": {
+			"description": "Annual Historical Year for electricity emissions. Options: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.",
+			"type": "string",
+			"enum": [
+				"2007",
+				"2009",
+				"2010",
+				"2012",
+				"2014",
+				"2016",
+				"2018",
+				"2019"
+			]
 		}
 	},
 	"required": [
-		"latitude",
-		"longitude"
 	],
 	"additionalProperties": false
-}
+}

data/lib/urbanopt/geojson/version.rb

@@ -40,6 +40,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.8.0'.freeze
+    VERSION = '0.8.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-geojson
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler