urbanopt-geojson 0.1.0

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

@@ -0,0 +1,137 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "title": "URBANopt District System",
+  "description": "Schema for an URBANopt District System object",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "District System"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name",
+      "type": "string"
+    },
+    "legal_name": {
+      "description": "Legal name used to identify this feature.",
+      "type": "string"
+    },
+    "address": {
+      "description": "Street address",
+      "type": "string"
+    },
+    "district_system_type": {
+      "$ref": "#/definitions/districtSystemType"
+    },
+    "detailed_model_filename": {
+      "description": "Name of a detailed model which can be loaded from disk as a seed model or complete model. Mapper class decides which measures to disable if this is present.",
+      "type": "string"
+    },
+    "weather_filename": {
+      "description": "Name of EPW weather file for this district system. Defaults to site's weather_filename.",
+      "type": "string"
+    },
+    "tariff_filename": {
+      "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"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "district_system_type"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "districtSystemType": {
+      "description": "Type of district system.",
+      "type": "string",
+      "enum": [
+        "District Thermal",
+        "Community Photovoltaic",
+        "Transformer"
+      ]
+    },
+    "equipmentType": {
+      "description": "Type of equipment, listed in order of load served.",
+      "type": "string",
+      "enum": [
+        "Air-Cooled Chiller--Cold Water",
+        "Air-Cooled Chiller--Ambient Water",
+        "Water-Cooled Chiller--Cold Water",
+        "Water-Cooled Chiller---Ambient Water",
+        "Cooling Tower--Heat Rejection from Chiller, Cold Water",
+        "Cooling Tower--Heat Rejection from Chiller, Ambient Water",
+        "Cooling Tower--Direct--Chilled Water",
+        "Cooling Tower--Direct--Ambient Water",
+        "Boiler--Hot Water",
+        "Boiler--Ambient Water",
+        "Boiler--Combined Heat and Power--Hot Water",
+        "Boiler--Combined Heat and Power--Ambient Water",
+        "Water to Water Heat Pump--Ambient Water",
+        "Water to Water Heat Pump--Cold Water",
+        "Water to Water Heat Pump--Hot Water",
+        "Air to Water Heat Pump--Ambient Water",
+        "Air to Water Heat Pump--Cold Water",
+        "Air to Water Heat Pump--Hot Water",
+        "Ground Source Heat Pump--Ambient Water",
+        "Ground Source Heat Pump--Cold Water",
+        "Ground Source Heat Pump--Hot Water",
+        "Solar Thermal Array--Ambient Water",
+        "Solar Thermal Array--Hot Water",
+        "Storage--Hot Water",
+        "Storage--Cold Water",
+        "Storage--Ambient Water",
+        "Waste Heat Source--Hot Water",
+        "Waste Heat Source--Ambient Water"
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,77 @@
+{
+  "$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",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "ElectricalConnector"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name",
+      "type": "string"
+    },
+    "connector_type": {
+      "$ref": "#/definitions/ElectricalConnectorType"
+    },
+    "lengths": {
+      "description": "Length (ft) of each segment, generated on export.",
+      "type": "array",
+      "items": {
+        "type": "number"
+      }
+    },
+    "total_length": {
+      "description": "Total length (ft) of the connector, generated on export.",
+      "type": "number"
+    },
+    "start_junction_id": {
+      "description": "Id of the junction that this connector starts at.",
+      "type": "string"
+    },
+    "end_junction_id": {
+      "description": "Id of the junction that this connector ends at.",
+      "type": "string"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "connector_type",
+    "start_junction_id",
+    "end_junction_id"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "ElectricalConnectorType": {
+      "description": "Type of electrical connector",
+      "type": "string",
+      "enum": [
+        "Wire"
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,64 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "title": "URBANopt Electrical Junction",
+  "description": "Schema for an URBANopt Electrical Junction object",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "ElectricalJunction"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name",
+      "type": "string"
+    },
+    "connector_type": {
+      "$ref": "#/definitions/ElectricalJunctionType"
+    },
+    "building_id": {
+      "description": "Id of building if this junction is inside a building.",
+      "type": "string"
+    },
+    "district_system_id": {
+      "description": "Id of district system if this junction is inside a district system.",
+      "type": "string"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "connector_type"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "ElectricalJunctionType": {
+      "description": "Type of electrical junction",
+      "type": "string",
+      "enum": [
+        "ElectricalPanel"
+      ]
+    }
+  }
+}

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

@@ -0,0 +1,323 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema#",
+	"id": "http://json-schema.org/geojson/geojson.json#",
+	"title": "Geo JSON object",
+	"description": "Schema for a Geo JSON object",
+	"type": "object",
+	"required": [
+		"type"
+	],
+	"properties": {
+		"crs": {
+			"$ref": "#/definitions/crs"
+		},
+		"bbox": {
+			"$ref": "#/definitions/bbox"
+		}
+	},
+	"oneOf": [
+		{
+			"$ref": "#/definitions/bbox"
+		}, {
+			"$ref": "#/definitions/geometryCollection"
+		}, {
+			"$ref": "#/definitions/feature"
+		}, {
+			"$ref": "#/definitions/featureCollection"
+		}
+	],
+	"definitions": {
+		"position": {
+			"description": "A single position",
+			"type": "array",
+			"minItems": 2,
+			"items": [
+				{
+					"type": "number"
+				}, {
+					"type": "number"
+				}
+			],
+			"additionalItems": false
+		},
+		"positionArray": {
+			"description": "An array of positions",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/position"
+			}
+		},
+		"lineString": {
+			"description": "An array of two or more positions",
+			"allOf": [
+				{
+					"$ref": "#/definitions/positionArray"
+				}, {
+					"minItems": 2
+				}
+			]
+		},
+		"linearRing": {
+			"description": "An array of four positions where the first equals the last",
+			"allOf": [
+				{
+					"$ref": "#/definitions/positionArray"
+				}, {
+					"minItems": 4
+				}
+			]
+		},
+		"polygon": {
+			"description": "An array of linear rings",
+			"type": "array",
+			"items": {
+				"$ref": "#/definitions/linearRing"
+			}
+		},
+		"geometry": {
+			"title": "geometry",
+			"description": "One geometry as defined by GeoJSON",
+			"type": "object",
+			"required": [
+				"type", "coordinates"
+			],
+			"oneOf": [
+				{
+					"title": "Point",
+					"properties": {
+						"type": {
+							"enum": [
+								"Point"
+							]
+						},
+						"coordinates": {
+							"$ref": "#/definitions/position"
+						}
+					}
+				}, {
+					"title": "MultiPoint",
+					"properties": {
+						"type": {
+							"enum": [
+								"MultiPoint"
+							]
+						},
+						"coordinates": {
+							"$ref": "#/definitions/positionArray"
+						}
+					}
+				}, {
+					"title": "LineString",
+					"properties": {
+						"type": {
+							"enum": [
+								"LineString"
+							]
+						},
+						"coordinates": {
+							"$ref": "#/definitions/lineString"
+						}
+					}
+				}, {
+					"title": "MultiLineString",
+					"properties": {
+						"type": {
+							"enum": [
+								"MultiLineString"
+							]
+						},
+						"coordinates": {
+							"type": "array",
+							"items": {
+								"$ref": "#/definitions/lineString"
+							}
+						}
+					}
+				}, {
+					"title": "Polygon",
+					"properties": {
+						"type": {
+							"enum": [
+								"Polygon"
+							]
+						},
+						"coordinates": {
+							"$ref": "#/definitions/polygon"
+						}
+					}
+				}, {
+					"title": "MultiPolygon",
+					"properties": {
+						"type": {
+							"enum": [
+								"MultiPolygon"
+							]
+						},
+						"coordinates": {
+							"type": "array",
+							"items": {
+								"$ref": "#/definitions/polygon"
+							}
+						}
+					}
+				}
+			]
+		},
+		"linkedObject": {
+			"type": "object",
+			"required": [
+				"href"
+			],
+			"properties": {
+				"href": {
+					"type": "string",
+					"format": "uri",
+					"FIXME": "spec says \"dereferenceable\", cannot enforce that"
+				},
+				"type": {
+					"type": "string",
+					"description": "Suggested values: proj4, ogjwkt, esriwkt"
+				}
+			}
+		},
+		"linkedCrs": {
+			"properties": {
+				"type": {
+					"enum": [
+						"link"
+					]
+				},
+				"properties": {
+					"$ref": "#/definitions/linkedObject"
+				}
+			}
+		},
+		"namedCrs": {
+			"properties": {
+				"type": {
+					"enum": [
+						"name"
+					]
+				},
+				"properties": {
+					"required": [
+						"name"
+					],
+					"additionalProperties": false,
+					"properties": {
+						"name": {
+							"type": "string",
+							"FIXME": "semantic validation necessary"
+						}
+					}
+				}
+			}
+		},
+		"crs": {
+			"$schema": "http://json-schema.org/draft-04/schema#",
+			"title": "crs",
+			"description": "a Coordinate Reference System object",
+			"type": [
+				"object", "null"
+			],
+			"required": [
+				"type", "properties"
+			],
+			"properties": {
+				"type": {
+					"type": "string"
+				},
+				"properties": {
+					"type": "object"
+				}
+			},
+			"additionalProperties": false,
+			"oneOf": [
+				{
+					"$ref": "#/definitions/namedCrs"
+				}, {
+					"$ref": "#/definitions/linkedCrs"
+				}
+			]
+		},
+		"bbox": {
+			"description": "A bounding box as defined by GeoJSON",
+			"FIXME": "unenforceable constraint: even number of elements in array",
+			"type": "array",
+			"items": {
+				"type": "number"
+			}
+		},
+		"geometryCollection": {
+			"title": "GeometryCollection",
+			"description": "A collection of geometry objects",
+			"required": [
+				"geometries"
+			],
+			"properties": {
+				"type": {
+					"enum": [
+						"GeometryCollection"
+					]
+				},
+				"geometries": {
+					"type": "array",
+					"items": {
+						"$ref": "#/definitions/geometry"
+					}
+				}
+			}
+		},
+		"feature": {
+			"title": "Feature",
+			"description": "A Geo JSON feature object",
+			"required": [
+				"geometry", "properties"
+			],
+			"properties": {
+				"type": {
+					"enum": [
+						"Feature"
+					]
+				},
+				"geometry": {
+					"oneOf": [
+						{
+							"type": "null"
+						}, {
+							"$ref": "#/definitions/geometry"
+						}
+					]
+				},
+				"properties": {
+					"type": [
+						"object", "null"
+					]
+				},
+				"id": {
+					"FIXME": "may be there, type not known (string? number?)"
+				}
+			}
+		},
+		"featureCollection": {
+			"title": "FeatureCollection",
+			"description": "A Geo JSON feature collection",
+			"required": [
+				"features"
+			],
+			"properties": {
+				"type": {
+					"enum": [
+						"FeatureCollection"
+					]
+				},
+				"features": {
+					"type": "array",
+					"items": {
+						"$ref": "#/definitions/feature"
+					}
+				}
+			}
+		}
+	}
+}