Brick is an open-source, BSD-licensed development effort to create a uniform schema for representing metadata in buildings. Brick has three components:
- An RDF class hierarchy describing the various building subsystems and the entities and equipment therein
- A minimal, principled set of relationships for connecting these entities together into a directed graph representing a building
- A method of encapsulation for composing complex components from a set of lower-level ones
The official Brick website, http://brickschema.org/, contains documentation and other information about the Brick schema.
This repository tracks the main schema development of Brick.
Discussion takes place primarily on the Brick User Form: htt 7B6F ps://groups.google.com/forum/#!forum/brickschema
If you have an issue with Brick's coverage, utility or usability, or any other Brick-related question:
- First check the Brick user form and the Brick issue tracker to check if anyone has asked your question already.
- If you find a previously submitted issue that closely mirrors your own, feel free to jump in on the conversation. Otherwise, please file a new issue or submit a new thread on the forum.
The examples/ directory contains executable code samples with extensive documentation that introduce Brick concepts and idioms.
example1: getting familiar with RDFlib, namespaces, Brick models and when and when not to import the Brick ontology definitionsimple_apartment: uses Python to programmatically build a Brick model of a small apartmentg36: contains Brick implementations of several figures from ASHRAE Guideline 36
See CONTRIBUTING.md
Tests go in the tests/ directory and should be implemented using pytest.
tests/test_inference.py is a good example.
Run tests by executing pytest in the top-level directory of this repository.
Rather than getting lost in the Sisyphean bikeshedding of how to format everything as YAML, we're just using Python dictionaries so we don't have to worry about any (well, not that much) parsing logic.
For now, the code is the documentation. Look at bricksrc/equipment.py, bricksrc/point.py, etc. for examples and how to add to each of the class hierarchies.
We can track the different classes between versions. The below scripts produces comparison files.
python tools/compare_versions/compare_versions.py --oldbrick 1.0.3 https://github.com/BrickSchema/Brick/releases/download/v1.0.3/Brick.ttl --newbrick 1.1.0 ./Brick.ttl
It will produce three files inside history/{current_version}.
added_classes.txt: A list of new classes introduced in the current version compared to the previous version.removed_classes.txt: A list of old classes removed in the current version compared to the previous version.possible_mapping.json: A map of candidate classes that can replace removed classes. Keys are removed classes and the values are candidate correspondants in the new vesion.