urbanopt-geojson 0.1.0 → 0.2.0.pre1

data/lib/urbanopt/geojson/region.rb

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

@@ -64,6 +64,28 @@
       "description": "The surface elevation (above NAVD88 datum) of the building (ft).  This is the elevation of the ground at the building location, any below ground stories will be lower than this. Defaults to site's surface_elevation.",
       "type": "number"
     },
+    "timesteps_per_hour": {
+      "description": "Number of timesteps per hour for energy simulations. Defaults to site's timesteps_per_hour.",
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 60
+    },
+    "begin_date": {
+      "description": "Date to begin simulation, format YYYY-MM-DD. Defaults to site's begin_date.",
+      "type": "string"
+    },
+    "end_date": {
+      "description": "Date to end simulation, format YYYY-MM-DD. Defaults to site's end_date.",
+      "type": "string"
+    },
+    "climate_zone": {
+      "description": "ASHRAE 169 climate zone. Defaults to site's climate_zone",
+      "type": "string"
+    },
+    "cec_climate_zone": {
+      "description": "CEC Title24 climate zone. Defaults to site's cec_climate_zone",
+      "type": "string"
+    },
     "floor_area": {
       "description": "Usable floor area (ft^2).",
       "type": "number"
@@ -111,7 +133,7 @@
       "$ref": "#/definitions/systemType"
     },
     "weekday_start_time": {
-      "description": "Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave black to use default. Should this be part of a mixed type struct?",
+      "description": "Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default. Should this be part of a mixed type struct?",
       "type": "string"
     },
     "weekday_duration": {
@@ -119,7 +141,7 @@
       "type": "string"
     },
     "weekend_start_time": {
-      "description": "Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave black to use default. Should this be part of a mixed type struct?",
+      "description": "Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default. Should this be part of a mixed type struct?",
       "type": "string"
     },
     "weekend_duration": {
@@ -201,7 +223,7 @@
     "footprint_area",
     "building_type"
   ],
-  "additionalProperties": false,
+  "additionalProperties": true,
   "definitions": {
     "buildingType": {
       "description": "Primary building space type.",
@@ -232,7 +254,8 @@
         "Service",
         "Mixed use",
         "Uncovered Parking",
-        "Covered Parking"
+        "Covered Parking",
+        "null"
       ]
     },
     "systemType": {
@@ -321,7 +344,7 @@
       ]
     },
     "templateType": {
-      "description": "Standard template applied to building.",
+      "description": "Standard template applied to building. Default to site's default_template",
       "type": "string",
       "enum": [
         "DOE Ref Pre-1980",

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

@@ -55,30 +55,13 @@
       "description": "Name of the tariff file for this district system. Defaults to site's tariff_filename.",
       "type": "string"
     },
-    "equipment_1": {
-      "description": "First piece of equipment used in this plant",
-      "$ref": "#/definitions/equipmentType",
-      "type": "string"
-    },
-    "equipment_2": {
-      "description": "Second piece of equipment used in this plant",
-      "$ref": "#/definitions/equipmentType",
-      "type": "string"
-    },
-    "equipment_3": {
-      "description": "Third piece of equipment used in this plant",
-      "$ref": "#/definitions/equipmentType",
-      "type": "string"
-    },
-    "equipment_4": {
-      "description": "Fourth piece of equipment used in this plant",
-      "$ref": "#/definitions/equipmentType",
-      "type": "string"
-    },
-    "equipment_5": {
-      "description": "Fifth piece of equipment used in this plant",
-      "$ref": "#/definitions/equipmentType",
-      "type": "string"
+    "equipment": {
+      "description": "List of equipment in this plant",
+      "type": "array",
+      "items": {
+          "$ref": "#/definitions/equipmentType",
+          "type": "string"
+      }
     },
     "user_data": {
       "description": "Arbitrary user data"
@@ -94,9 +77,16 @@
       "description": "Type of district system.",
       "type": "string",
       "enum": [
-        "District Thermal",
-        "Community Photovoltaic",
-        "Transformer"
+        "Central Chilled Water",
+        "Central Hot Water",
+        "Central Hot and Chilled Water",
+		    "Central Ambient Water",
+		    "Central Hot and Cold Water", 
+		    "Community Photovoltaic", 
+        "Transformer",
+        "Transformer with Storage",
+		    "Capacitor",
+		    "Electrical Substation" 
       ]
     },
     "equipmentType": {
@@ -107,6 +97,8 @@
         "Air-Cooled Chiller--Ambient Water",
         "Water-Cooled Chiller--Cold Water",
         "Water-Cooled Chiller---Ambient Water",
+        "Capacitor--150KVAR",
+        "Capacitor--450KVAR",
         "Cooling Tower--Heat Rejection from Chiller, Cold Water",
         "Cooling Tower--Heat Rejection from Chiller, Ambient Water",
         "Cooling Tower--Direct--Chilled Water",
@@ -129,9 +121,18 @@
         "Storage--Hot Water",
         "Storage--Cold Water",
         "Storage--Ambient Water",
+        "Transformer--25KVA CT",
+        "Transformer--50KVA CT",
+        "Transformer--75KVA CT",
+        "Transformer--25KVA PM",
+        "Transformer--50KVA PM",
+        "Transformer--75KVA PM",
+        "Transformer--100KVA PM",
+        "Transformer--150KVA PM",
+        "Transformer--300KVA PM",
         "Waste Heat Source--Hot Water",
         "Waste Heat Source--Ambient Water"
       ]
     }
   }
-}
+}

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

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
-  "title": "URBANopt Electrical Connector",
-  "description": "Schema for an URBANopt Electrical Connector object",
+  "title": "URBANopt Electrical Line",
+  "description": "Schema for an URBANopt Electrical Line object",
   "type": "object",
   "properties": {
     "id": {
@@ -17,7 +17,7 @@
       "description": "Type of feature.",
       "type": "string",
       "enum": [
-        "ElectricalConnector"
+        "ElectricalLine"
       ]
     },
     "source_name": {
@@ -33,7 +33,7 @@
       "type": "string"
     },
     "connector_type": {
-      "$ref": "#/definitions/ElectricalConnectorType"
+      "$ref": "#/definitions/ElectricalLineType"
     },
     "lengths": {
       "description": "Length (ft) of each segment, generated on export.",
@@ -43,15 +43,32 @@
       }
     },
     "total_length": {
-      "description": "Total length (ft) of the connector, generated on export.",
+      "description": "Total length (ft) of the line, generated on export.",
       "type": "number"
     },
     "start_junction_id": {
-      "description": "Id of the junction that this connector starts at.",
+      "description": "Id of the junction that this line starts at.",
       "type": "string"
     },
+    "line_properties":{
+        "description": "A sub-element containing all the attributes that can be assigned to a line, including wires",
+        "type":"object",
+        "properties":{
+            "is_switch":{"type":"boolean","description":"Flag indicating if the line is a switch or not"},
+            "is_fuse":{"type":"boolean","description":"Flag indicating if the line is a fuse or not"},
+            "is_open":{"type":"boolean","description":"Flag indicating if the switch/fuse is a open or not"}
+        }
+    },
+    "wires": {
+        "description": "Array of wires that are on the line",
+        "type": "array",
+        "items": {
+            "$ref": "#/definitions/WireType",
+            "type": "string"
+        }
+    },
     "end_junction_id": {
-      "description": "Id of the junction that this connector ends at.",
+      "description": "Id of the junction that this line ends at.",
       "type": "string"
     },
     "user_data": {
@@ -60,17 +77,140 @@
   },
   "required": [
     "type",
+    "id",
     "connector_type",
     "start_junction_id",
     "end_junction_id"
   ],
   "additionalProperties": false,
   "definitions": {
-    "ElectricalConnectorType": {
-      "description": "Type of electrical connector",
+    "ElectricalLineType": {
+      "description": "Type of electrical line",
+      "type": "string",
+      "enum": [
+        "Line"
+      ]
+    },
+    "WireType": {
+      "description": "Type of wire used",
       "type": "string",
       "enum": [
-        "Wire"
+        "OH TPLX #4 S1",
+        "OH TPLX #4 S2",
+        "OH TPLX #4 A",
+        "OH TPLX #4 B",
+        "OH TPLX #4 C",
+        "OH TPLX #4 N",
+        "OH TPLX 1/0 S1",
+        "OH TPLX 1/0 S2",
+        "OH TPLX 1/0 A",
+        "OH TPLX 1/0 B",
+        "OH TPLX 1/0 C",
+        "OH TPLX 1/0 N",
+        "OH TPLX 2/0 S1",
+        "OH TPLX 2/0 S2",
+        "OH TPLX 2/0 A",
+        "OH TPLX 2/0 B",
+        "OH TPLX 2/0 C",
+        "OH TPLX 2/0 N",
+        "OH TPLX 4/0 S1",
+        "OH TPLX 4/0 S2",
+        "OH TPLX 4/0 A",
+        "OH TPLX 4/0 B",
+        "OH TPLX 4/0 C",
+        "OH TPLX 4/0 N",
+        "OH AL #2 A",
+        "OH AL #2 B",
+        "OH AL #2 C",
+        "OH AL #2 N",
+        "OH AL #4 A",
+        "OH AL #4 B",
+        "OH AL #4 C",
+        "OH AL #4 N",
+        "OH AL 1/0 A",
+        "OH AL 1/0 B",
+        "OH AL 1/0 C",
+        "OH AL 1/0 N",
+        "OH AL 2/0 A",
+        "OH AL 2/0 B",
+        "OH AL 2/0 C",
+        "OH AL 2/0 N",
+        "OH AL 4/0 A",
+        "OH AL 4/0 B",
+        "OH AL 4/0 C",
+        "OH AL 4/0 N",
+        "OH AL 336kcmil A",
+        "OH AL 336kcmil B",
+        "OH AL 336kcmil C",
+        "OH AL 336kcmil N",
+        "OH AL 477kcmil A",
+        "OH AL 477kcmil B",
+        "OH AL 477kcmil C",
+        "OH AL 477kcmil N",
+        "OH AL 795kcmil A",
+        "OH AL 795kcmil B",
+        "OH AL 795kcmil C",
+        "OH AL 795kcmil N",
+        "UG TPLX #4 S1",
+        "UG TPLX #4 S2",
+        "UG TPLX #4 A",
+        "UG TPLX #4 B",
+        "UG TPLX #4 C",
+        "UG TPLX #4 N",
+        "UG TPLX 1/0 S1",
+        "UG TPLX 1/0 S2",
+        "UG TPLX 1/0 A",
+        "UG TPLX 1/0 B",
+        "UG TPLX 1/0 C",
+        "UG TPLX 1/0 N",
+        "UG TPLX 2/0 S1",
+        "UG TPLX 2/0 S2",
+        "UG TPLX 2/0 A",
+        "UG TPLX 2/0 B",
+        "UG TPLX 2/0 C",
+        "UG TPLX 2/0 N",
+        "UG TPLX 4/0 S1",
+        "UG TPLX 4/0 S2",
+        "UG TPLX 4/0 A",
+        "UG TPLX 4/0 B",
+        "UG TPLX 4/0 C",
+        "UG TPLX 4/0 N",
+        "UG AL #2 A",
+        "UG AL #2 B",
+        "UG AL #2 C",
+        "UG AL #2 N",
+        "UG AL #4 A",
+        "UG AL #4 B",
+        "UG AL #4 C",
+        "UG AL #4 N",
+        "UG AL 1/0 A",
+        "UG AL 1/0 B",
+        "UG AL 1/0 C",
+        "UG AL 1/0 N",
+        "UG AL 2/0 A",
+        "UG AL 2/0 B",
+        "UG AL 2/0 C",
+        "UG AL 2/0 N",
+        "UG AL 4/0 A",
+        "UG AL 4/0 B",
+        "UG AL 4/0 C",
+        "UG AL 4/0 N",
+        "UG AL 350kcmil A",
+        "UG AL 350kcmil B",
+        "UG AL 350kcmil C",
+        "UG AL 350kcmil N",
+        "UG AL 500kcmil A",
+        "UG AL 500kcmil B",
+        "UG AL 500kcmil C",
+        "UG AL 500kcmil N",
+        "UG AL 750kcmil A",
+        "UG AL 750kcmil B",
+        "UG AL 750kcmil C",
+        "UG AL 750kcmil N",
+        "UG AL 1000kcmil A",
+        "UG AL 1000kcmil B",
+        "UG AL 1000kcmil C",
+        "UG AL 1000kcmil N"
       ]
     }
   }

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

@@ -49,6 +49,7 @@
   },
   "required": [
     "type",
+    "id",
     "connector_type"
   ],
   "additionalProperties": false,
@@ -57,8 +58,8 @@
       "description": "Type of electrical junction",
       "type": "string",
       "enum": [
-        "ElectricalPanel"
+        "ElectricalJunction"
       ]
     }
   }
-}
+}

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

@@ -100,7 +100,8 @@
       "type": "string",
       "enum": [
         "Supply",
-        "Return"
+        "Return",
+        "Unspecified"
       ]
     }
   }

data/lib/urbanopt/geojson/update_areas.rb

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

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, 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,
@@ -30,6 +30,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0.pre1'.freeze
   end
 end

data/lib/urbanopt/geojson/zoning.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, 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/urbanopt-geojson-gem.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  # this is not working right now
+  # spec.required_ruby_version = '~> 2.2.4'
+  
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '12.3.1'
   spec.add_development_dependency 'rspec', '3.7.0'
@@ -34,6 +37,6 @@ Gem::Specification.new do |spec|
 
   # other dependencies
   spec.add_dependency 'json-schema'
-  spec.add_dependency 'openstudio-extension', '~> 0.1.3'
+  spec.add_dependency 'openstudio-extension', '~> 0.1.5'
   spec.add_dependency 'urbanopt-core', '~> 0.1.0'
 end