building_graphs

Building of Haystack / Brick Graphs

Introduction

The purpose of this repo is to provide examples and utility functions for working with Brick / Haystack data. Haystack is used predominantly in industry, but the Haystack 4.0 standard is currently being developed to provide additional structure to the Haystack standard. Previous concerns about the implementation of the Haystack standard across organizations (many of whom define custom tags), as well as recent HouseOfSticks paper raises many good questions about Haystack. The following questions can currently be answered using utility functions in this repo (all questions are wrt the Haystack 4.0 specification):

1. Which markers or vals used in the model are valid / invalid (custom)?
2. For each entity, which markers or vals are valid / invalid (custom)?
3. Is a first class entity type defined for each entity?
4. What is the lowest 'entity subtype' defined for the entity?
5. How many times are different vals / markers used in the model definition, broken out by how they are applied to different first class entity types?

Generally, other questions which intend to be answered:

1. How to understand what is in a Haystack model?
2. Which tags applied are specified in the standard vs. custom?
3. Are defined tags used correctly in combination with other tags to correctly implement typing?
4. How do I know the full set of tags required for a specific type of equipment, point, etc.?

This repository intends to provide methods / open source examples for how to accomplish this.

Info on Files

General			Haystack Entities				First Class Entity Types				Lowest Subclass
Site Number	Site Name	File Name	Total	Valid First Class	No Valid First Class	Multiple Valid First Class	equip	point	site	space	ahu	elec-meter	equip	fcu	meter	vav
1	Carytown	carytown.json	22	22	0	0	4	17	1	0	1	1	2	0	0	0
2	Gaithersburg	gaithersburg.json	147	143	4	0	31	108	4	0	6	9	13	0	3	0
3	VRT Systems	vrtdump.json	149	146	1	2	30	111	2	3	0	0	30	0	0	0
4	Ghausi	ghausi.json	2183	125	2058	0	105	20	0	0	5	3	17		2	78
4.1	Ghausi	ghausi-improved.json	2183	1570	613	0	105	1465	0	0	5	3	9	8	2	78
5	Pes	pes.json	6474	229	6245	0	211	18	0	0	8	3	4	0	2	194

Plotting Utilities

Plots to analyze tags present on entities

plot1 is designed to create individual plots for each of the tag-categories:

1. invalid_vals: vals present in the model that ARE NOT specified by the Haystack 4.0 defs.ttl
2. invalid_markers: markers present in the model that ARE NOT specified by the Haystack 4.0 defs.ttl
3. valid_vals: vals present in the model that ARE specified by the Haystack 4.0 defs.ttl
4. valid_markers: markers present in the model that AREA specified by the Haystack 4.0 defs.ttl

Investigating valid_vals and valid_markers helps us to see similarites in first class entities with other entities, i.e. entities which do not have a first class entity defined.

Setup

1. Clone this repo
2. Create a new virtual environment and install dependencies defined in requirements.txt
3. Clone the brick-examples repo to the same directory level as building_graphs:

   root_dir/
       |-building_graphs
       |-brick-examples
   

examples

Example files showing how to implement and utilize utility functions to achieve a specific purpose. Comments in the files walk the user through the WHAT and WHY.

resources

RDF definitions serialized as TTL files for both Brick and Haystack. Stored locally for convenience.

scripts

Scripts designed to perform specific functions.