urbanopt-geojson 0.6.6 → 0.8.1

data/lib/measures/urban_geometry_creation/measure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/measures/urban_geometry_creation_zoning/measure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/building.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/derived_extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/district_system.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/feature.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -318,7 +318,7 @@ module URBANopt
           return false
         end
 
-        unless feature[:properties][:detailed_model_filename]
+        unless feature[:properties][:detailed_model_filename] || feature[:properties][:hpxml_directory]
           errors = JSON::Validator.fully_validate(schema, feature[:properties])
           if !errors.empty?
             raise("Invalid properties for '#{feature[:properties][:name]}'\n  #{errors.join('\n  ')}")

data/lib/urbanopt/geojson/geo_file.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -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]
@@ -100,7 +110,7 @@ module URBANopt
 
           case type
           when 'Building'
-            # Incase detailed_model_filename present check for fewer properties
+            # In case detailed_model_filename present check for fewer properties
             if feature[:properties][:detailed_model_filename]
               if feature[:properties][:id].nil?
                 raise('No id found for Building Feature')
@@ -112,6 +122,14 @@ module URBANopt
                 @@logger.warn("Number of stories is required to calculate shading using the UrbanGeometryCreation measure...ignoring #{feature[:properties][:id]} in shading calculations")
               end
               feature[:additionalProperties] = true
+            # In case hpxml_directory present check for fewer properties
+            elsif feature[:properties][:hpxml_directory]
+              if feature[:properties][:id].nil?
+                raise('No id found for Building Feature')
+              end
+              if feature[:properties][:name].nil?
+                raise('No name found for Building Feature')
+              end
             # Else validate for all required properties in the schema
             else
               errors = validate(@@building_schema, properties)
@@ -203,7 +221,14 @@ module URBANopt
           { site: :climate_zone, feature: :climate_zone },
           { site: :default_template, feature: :template },
           { site: :weather_filename, feature: :weather_filename },
-          { site: :tariff_filename, feature: :tariff_filename }
+          { site: :tariff_filename, feature: :tariff_filename },
+          { site: :emissions, feature: :emissions },
+          { 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|
@@ -280,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|
@@ -341,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/helper.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/logging.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/mapper_classes.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/model.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/region.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/scale_area.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/geojson/schema/breaker_properties.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/breaker_properties.json#",
+  "title": "URBANopt Breaker",
+  "description": "Schema for an URBANopt RNM Breaker object",
+  "type": "object",
+  "properties": {
+  	"Code": {
+      "description": "Unique name/ID of the feature in the RNM analysis.",
+      "type": "string"
+    },
+    "NodeA": {
+      "description": "Name/ID of the RNM 'From' Node it is associated with.",
+      "type": "string"
+    },
+    "NodeB": {
+      "description": "Name/ID of the RNM 'To' Node it is associated with.",
+      "type": "string"
+    },
+    "NomV_kV": {
+      "description": "Nominal Voltage in kV.",
+      "type": "string"
+    },
+    "Subest": {
+      "description": "Substation the breaker is connected to.",
+      "type": "string"
+    },
+    "Feeder": {
+      "description": "Feeder the breaker is connected to.",
+      "type": "string"
+    }
+  }
+}