2.1. Brick Conversion (Full).ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# Install necessary Python pakcages\n",
    "# rdflib: RDF composition and querying with SPARQL in Python.\n",
    "from rdflib import RDFS, RDF, Namespace, Graph, URIRef, Literal\n",
    "\n",
    "from common import *"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "import json\n",
    "import pandas as pd\n",
    "import re"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# Load knowledge for the conversion.\n",
    "with open('metadata/re_dict.json', 'r') as fp:\n",
    "    re_dict = json.load(fp)\n",
    "equip_order = ['AHU', 'Return_Fan', 'Supply_Fan']\n",
    "with open('metadata/zone_room_map.json', 'r') as fp:\n",
    "    zone_room_map = json.load(fp)\n",
    "    \n",
    "# Load raw data\n",
    "df = pd.read_csv('metadata/brick_sample_building_raw.csv')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# Consruct knowledge from Brick schema\n",
    "\n",
    "bg = Graph()\n",
    "bg.parse('Brick/dist/Brick.ttl', format='turtle') # Load Brick schema.\n",
    "subclasses_query = \"\"\"\n",
    "PREFIX brick: <https://brickschema.org/schema/1.0.1/Brick#>\n",
    "select ?tagset where {{\n",
    "?tagset rdfs:subClassOf+ brick:{0}.\n",
    "}}\n",
    "\"\"\"\n",
    "point_query = subclasses_query.format('Point')\n",
    "equip_query = subclasses_query.format('Equipment')\n",
    "loc_query = subclasses_query.format('Location')\n",
    "points = [str(row[0]).split('#')[-1] for row in bg.query(point_query)]\n",
    "equips = [str(row[0]).split('#')[-1] for row in bg.query(equip_query)]\n",
    "locs = [str(row[0]).split('#')[-1] for row in bg.query(loc_query)]\n",
    "\n",
    "# Cleanup rules\n",
    "equips = [equip for equip in equips if \\\n",
    "          not 'Command' in equip and\n",
    "          not 'Sensor' in equip and\n",
    "          not 'Status' in equip and\n",
    "          not 'Alarm' in equip\n",
    "         ]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g = Graph() # Initialize a graph\n",
    "RDFS # predefined namespace as 'http://www.w3.org/2000/01/rdf-schema#'\n",
    "RDF # predefined namespace as 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'\n",
    "BRICK = Namespace('https://brickschema.org/schema/1.0.1/Brick#')\n",
    "BF = Namespace('https://brickschema.org/schema/1.0.1/BrickFrame#')\n",
    "EX = Namespace('http://example.com#')\n",
    "g.bind('ex', EX)\n",
    "g.bind('brick', BRICK)\n",
    "g.bind('bf', BF)\n",
    "g.bind('rdfs', RDFS)\n",
    "g.bind('rdf', RDF)\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "for row in df.iterrows():\n",
    "    vendor_name = row[1]['Vendor Given Name']\n",
    "    uuid = row[1]['uuid']\n",
    "    ############# Parsing Phase\n",
    "    # Extract all entities in vendor_name\n",
    "    entity_dict = dict()\n",
    "    raw_words = vendor_name.split('.') # This building uses '.' as a delimiter but not always it's comprehensive.\n",
    "    \n",
    "    # split more if needed\n",
    "    words = []\n",
    "    for word in raw_words:\n",
    "        if 'SF' in word or 'RF' in word:\n",
    "            words += word.split('-')\n",
    "        else:\n",
    "            words.append(word)\n",
    "    # Apply RE rules to detect tagsets.\n",
    "    for word in words:\n",
    "        for key, tagset in re_dict.items():\n",
    "            if re.findall(key, word):\n",
    "                if tagset in points:\n",
    "                    entity_dict[vendor_name] = tagset\n",
    "                else:\n",
    "                    entity_dict[word] = tagset # We will use a word as an entity name.\n",
    "    \n",
    "    ############# Add Brick Relationships\n",
    "    # Add instance relationships\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        g.add((EX[entity], RDF['type'], BRICK[tagset]))\n",
    "    \n",
    "    # Add Location <-> Others\n",
    "    ## Find all location entities\n",
    "    loc_entities = list()\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset in locs:\n",
    "            loc_entities.append(entity)\n",
    "    ## Assign hasLocation relationships to all non-location entities with the location entities.\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset not in locs:\n",
    "            for loc_entity in loc_entities:\n",
    "                g.add((EX[entity], BF['hasLocation'], EX[loc_entity]))\n",
    "    \n",
    "    # Zone corresponds to a VAV.\n",
    "    vav_entity = None\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset == 'HVAC_Zone':\n",
    "            vav_entity = 'VAV_' + entity\n",
    "            g.add((EX[vav_entity], RDF['type'], BRICK['VAV']))\n",
    "            g.add((EX[vav_entity], BF['feeds'], EX[entity]))\n",
    "    if vav_entity:\n",
    "        entity_dict[vav_entity] = 'VAV'\n",
    "                \n",
    "    # Add Equip <-> Point\n",
    "    ## Find all equip entities\n",
    "    equip_entities = list()\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset in equips:\n",
    "            equip_entities.append(entity)\n",
    "    ## Assign isPointOf relationships to all Point entities \n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset in points:\n",
    "            for equip_entity in equip_entities:\n",
    "                g.add((EX[entity], BF['isPointOf'], EX[equip_entity]))\n",
    "    ## Add inclusive relationships among equipments\n",
    "    #if len(equip_entities) > 1:\n",
    "    #    rank_equip_list = [(equip, equip_orders.index(equip))]\n",
    "    #    sorted(equip_entities)\n",
    "    \n",
    "    # Add UUID\n",
    "    for entity, tagset in entity_dict.items():\n",
    "        if tagset in points:\n",
    "            g.add((EX[entity], BRICK['hasUuid'], Literal(str(uuid))))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# Add zone-room inclusive relationships\n",
    "for zone, rooms in zone_room_map.items():\n",
    "    for room in rooms:\n",
    "        g.add((EX[room], RDF['type'], BRICK['Room']))\n",
    "        g.add((EX[room], BF['isPartOf'], EX[zone]))\n",
    "        \n",
    "# The AHU feeds all VAVs\n",
    "## find VAVs.\n",
    "res = g.query(\"select ?vav where {?vav a <https://brickschema.org/schema/1.0.1/Brick#VAV>}\")\n",
    "vavs = [str(row[0]).split('#')[-1] for row in res]\n",
    "## Add feeds relationship\n",
    "for vav in vavs:\n",
    "    g.add((EX['AH1'], BF['feeds'], EX[vav]))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/markdown": [
       "```turtle\n",
       "@prefix bf: <https://brickschema.org/schema/1.0.1/BrickFrame#> .\n",
       "@prefix brick: <https://brickschema.org/schema/1.0.1/Brick#> .\n",
       "@prefix ex: <http://example.com#> .\n",
       "@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .\n",
       "@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .\n",
       "@prefix xml: <http://www.w3.org/XML/1998/namespace> .\n",
       "@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .\n",
       "\n",
       "ex:AH1-1 a brick:AHU ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:BLDA.AH1.CHWR1-T a brick:Chilled_Water_Return_Temperature_Sensor ;\n",
       "    brick:hasUuid \"1\" ;\n",
       "    bf:hasLocation ex:BLDA ;\n",
       "    bf:isPointOf ex:AH1 .\n",
       "\n",
       "ex:BLDA.AH1.CHWR2-T a brick:Chilled_Water_Return_Temperature_Sensor ;\n",
       "    brick:hasUuid \"2\" ;\n",
       "    bf:hasLocation ex:BLDA ;\n",
       "    bf:isPointOf ex:AH1 .\n",
       "\n",
       "ex:BLDA.AH1.CLG-VLV1 a brick:Cooling_Valve_Command ;\n",
       "    brick:hasUuid \"3\" ;\n",
       "    bf:hasLocation ex:BLDA ;\n",
       "    bf:isPointOf ex:AH1 .\n",
       "\n",
       "ex:BLDA.AH1.CLG-VLV2 a brick:Cooling_Valve_Command ;\n",
       "    brick:hasUuid \"4\" ;\n",
       "    bf:hasLocation ex:BLDA ;\n",
       "    bf:isPointOf ex:AH1 .\n",
       "\n",
       "ex:BLDA.RM-1100A..ACTCLGSP a brick:Effective_Cooling_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"15\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..ACTHTGSP a brick:Effective_Heating_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"16\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..COMMONSP a brick:Zone_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"18\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..DPR-C a brick:Damper_Command ;\n",
       "    brick:hasUuid \"20\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..OCC-CMD a brick:Occupied_Command ;\n",
       "    brick:hasUuid \"22\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..RH-VLV a brick:Reheat_Valve_Command ;\n",
       "    brick:hasUuid \"23\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..SUP-FLOW a brick:Supply_Air_Flow_Sensor ;\n",
       "    brick:hasUuid \"25\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100A..SUPFLO-SP a brick:Supply_Air_Flow_Setpoint ;\n",
       "    brick:hasUuid \"24\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100A ;\n",
       "    bf:isPointOf ex:VAV_RM-1100A .\n",
       "\n",
       "ex:BLDA.RM-1100D..ACTCLGSP a brick:Effective_Cooling_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"27\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..ACTHTGSP a brick:Effective_Heating_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"28\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..COMMONSP a brick:Zone_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"30\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..DPR-C a brick:Damper_Command ;\n",
       "    brick:hasUuid \"32\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..OCC-CMD a brick:Occupied_Command ;\n",
       "    brick:hasUuid \"34\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..RH-VLV a brick:Reheat_Valve_Command ;\n",
       "    brick:hasUuid \"35\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..SUP-FLOW a brick:Supply_Air_Flow_Sensor ;\n",
       "    brick:hasUuid \"37\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-1100D..SUPFLO-SP a brick:Supply_Air_Flow_Setpoint ;\n",
       "    brick:hasUuid \"36\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-1100D ;\n",
       "    bf:isPointOf ex:VAV_RM-1100D .\n",
       "\n",
       "ex:BLDA.RM-2150..ACTCLGSP a brick:Effective_Cooling_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"39\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..ACTHTGSP a brick:Effective_Heating_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"40\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..COMMONSP a brick:Zone_Temperature_Setpoint ;\n",
       "    brick:hasUuid \"42\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..DPR-C a brick:Damper_Command ;\n",
       "    brick:hasUuid \"44\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..HTGFLOW a brick:Occupied_Heating_Discharge_Air_Flow_Setpoint ;\n",
       "    brick:hasUuid \"45\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..OCC-CMD a brick:Occupied_Command ;\n",
       "    brick:hasUuid \"47\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..RH-VLV a brick:Reheat_Valve_Command ;\n",
       "    brick:hasUuid \"48\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..SUP-FLOW a brick:Supply_Air_Flow_Sensor ;\n",
       "    brick:hasUuid \"50\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:BLDA.RM-2150..SUPFLO-SP a brick:Supply_Air_Flow_Setpoint ;\n",
       "    brick:hasUuid \"49\" ;\n",
       "    bf:hasLocation ex:BLDA,\n",
       "        ex:RM-2150 ;\n",
       "    bf:isPointOf ex:VAV_RM-2150 .\n",
       "\n",
       "ex:RF a brick:Return_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:RF1 a brick:Return_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:RF2 a brick:Return_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:RM-1100 a brick:Room ;\n",
       "    bf:isPartOf ex:RM-1100A,\n",
       "        ex:RM-1100D .\n",
       "\n",
       "ex:RM-2151 a brick:Room ;\n",
       "    bf:isPartOf ex:RM-2150 .\n",
       "\n",
       "ex:RM-2152 a brick:Room ;\n",
       "    bf:isPartOf ex:RM-2150 .\n",
       "\n",
       "ex:SF a brick:Supply_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:SF1 a brick:Supply_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:SF2 a brick:Supply_Fan ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:AH1 a brick:AHU ;\n",
       "    bf:feeds ex:VAV_RM-1100A,\n",
       "        ex:VAV_RM-1100D,\n",
       "        ex:VAV_RM-2150 ;\n",
       "    bf:hasLocation ex:BLDA .\n",
       "\n",
       "ex:VAV_RM-1100A a brick:VAV ;\n",
       "    bf:feeds ex:RM-1100A .\n",
       "\n",
       "ex:VAV_RM-1100D a brick:VAV ;\n",
       "    bf:feeds ex:RM-1100D .\n",
       "\n",
       "ex:RM-1100A a brick:HVAC_Zone .\n",
       "\n",
       "ex:RM-1100D a brick:HVAC_Zone .\n",
       "\n",
       "ex:VAV_RM-2150 a brick:VAV ;\n",
       "    bf:feeds ex:RM-2150 .\n",
       "\n",
       "ex:RM-2150 a brick:HVAC_Zone .\n",
       "\n",
       "ex:BLDA a brick:Building .\n",
       "\n",
       "\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "print_graph(g)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Conversion Rules (for this building)\n",
    "1. A metadata is the name of the data point.\n",
    "2. Implicit Relationships:\n",
    "  - When a location is found, every other entitiy hasLocation the location.\n",
    "  - When equipment is is found, the point isPointOf the equipment.\n",
    "  - When multiple equipment is found, their hierarchy is assumed. In AHU-SF, SF isPartOf AHU. Same for AHU-RF.\n",
    "  - When HVAC Zone is found, there is a corresponding VAV."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g.serialize('metadata/sample_building.ttl', format='turtle')"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.1"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}