Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Brick

An open-source effort to standardize semantic descriptions of the physical, logical and virtual assets in buildings and the relationships between them.
https://github.com/BrickSchema/Brick

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

brick-schema measur archiving transforms animals optimize generic projection serializer observation

Last synced: about 5 hours ago
JSON representation

Repository metadata

Uniform metadata schema for buildings

README.md

Brick

Build Status
Python 3.6

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

Discussion takes place primarily on the Brick User Forum: https://groups.google.com/forum/#!forum/brickschema

Questions and Issues

If you have an issue with Brick's coverage, utility or usability, or any other Brick-related question:

  1. First check the Brick user forum and the Brick issue tracker
    to check if anyone has asked your question already.
  2. 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.

Examples

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 definition
  • simple_apartment: uses Python to programmatically build a Brick model of a small apartment
  • g36: contains Brick implementations of several figures from ASHRAE Guideline 36

Versioning

Brick uses a semantic versioning scheme for its version numbers: major.minor.patch. The releases page contains links to each published Brick release for easy download.

We target a minor version release (e.g. 1.1, 1.2, 1.3) roughly every 6 months. Minor releases will contain largely backwards-compatible extensions and new features to the ontology. Due to the significance of these changes, minor releases will be developed in their own branch; PRs for those releases will be merged into the minor version branch, and then ultimately merged into the main branch when the minor release is published.

Patch releases (e.g. 1.2.1, 1.2.2) contain smaller, incremental, backwards-compatible changes to the ontology. Commits and PRs for the next patch release will be merged directly into master. Every evening, a nightly build is produced containing the latest commits. There may be bugs or errors in the nightly release, however these bugs will be removed by the time a patch release is published.

How To Contribute

See CONTRIBUTING.md

Tests

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 or make test in the top-level directory of this repository.

  • Before running pytest the Brick.ttl file needs to be created using either make or python generate_brick.py.

Python Framework

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.

Other Tools

Version Comparison

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://brickschema.org/schema/1.0.3/Brick.ttl --newbrick 1.1.0 ./Brick.ttl

It will produce three files inside history/{old_version}-{new_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.

The Brick Development Team was initiated to produce a unified metadata schema for resources in buildings in early 2016. The team consists of members from IBM; Carnegie Mellon University; University of California, Berkeley; University of California, Los Angeles; University of California, San Diego; University of Virginia and University of Southern Denmark.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 839
Total Committers: 28
Avg Commits per committer: 29.964
Development Distribution Score (DDS): 0.558

Commits in past year: 28
Committers in past year: 3
Avg Commits per committer in past year: 9.333
Development Distribution Score (DDS) in past year: 0.429

Name Email Commits
Gabe Fierro g****o@c****u 371
Jason Koh b****9@g****m 146
Xiaolin (Charlene) Zang c****g@c****u 86
Connor Cantrell 3****l 65
shreyasnagare s****e@g****m 45
KiithNabaal m****k@y****m 28
steveraysteveray s****e@s****m 19
metesaka m****8@g****m 11
Carlos Duarte c****e@b****u 10
Joern Ploennigs J****s@i****m 10
ektrah e****h 9
Jonas Bülow j****w@g****m 6
anil72007 n****l@g****m 6
Jonas Bülow j****w@s****m 5
Erik Paulson e****n@u****m 5
Georg Ferdinand Schneider 1****r 2
corymosiman12 c****2@g****m 2
wcrd 1****d 2
Karl Hammar k****r@m****m 2
dependabot[bot] 4****] 1
Mike Finch G****k 1
Joel Bender j****l@c****m 1
Jacob Hicks h****p 1
Filip Henrik Larsen 8****l 1
David Waterworth w****a@g****m 1
Daniel Hugo d****o@c****u 1
Ben Hussey b****n@b****t 1
Ambuj Shatdal 8****l 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 277
Total pull requests: 438
Average time to close issues: 4 months
Average time to close pull requests: about 1 month
Total issue authors: 79
Total pull request authors: 30
Average comments per issue: 3.52
Average comments per pull request: 2.58
Merged pull request: 371
Bot issues: 0
Bot pull requests: 1

Past year issues: 28
Past year pull requests: 42
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 13 days
Past year issue authors: 13
Past year pull request authors: 5
Past year average comments per issue: 2.36
Past year average comments per pull request: 1.48
Past year merged pull request: 34
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/BrickSchema/Brick

Top Issue Authors

  • gtfierro (42)
  • jbkoh (37)
  • epaulson (14)
  • corymosiman12 (14)
  • connorjcantrell (13)
  • jbulow (11)
  • PeteHart (11)
  • ektrah (8)
  • JoelBender (5)
  • sarahmacSE978 (5)
  • s0301132 (5)
  • bbalaji-ucsd (5)
  • steveraysteveray (4)
  • MatthewSteen (4)
  • david-waterworth (4)

Top Pull Request Authors

  • gtfierro (225)
  • jbkoh (57)
  • connorjcantrell (37)
  • steveraysteveray (25)
  • shreyasnagare (15)
  • carlosduarteroa (15)
  • ektrah (12)
  • jbulow (9)
  • epaulson (7)
  • corymosiman12 (5)
  • wcrd (4)
  • hammar (3)
  • jli113 (3)
  • anil72007 (2)
  • GeorgFerdinandSchneider (2)

Top Issue Labels

  • Add/Amend Concepts (29)
  • bug (15)
  • Ontology/OWL/RDF (12)
  • Alignment/Mapping (6)
  • Beginner Friendly (5)
  • question (3)
  • Examples (1)
  • Documentation (1)

Top Pull Request Labels

  • Add/Amend Concepts (6)
  • bug (3)
  • Ontology/OWL/RDF (3)
  • dependencies (1)

Package metadata

proxy.golang.org: github.com/brickschema/brick

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/brickschema/brick#section-documentation
  • Licenses: other
  • Latest release: v1.4.3 (published about 1 month ago)
  • Last Synced: 2025-04-26T14:06:02.080Z (1 day ago)
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%
proxy.golang.org: github.com/BrickSchema/Brick

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/BrickSchema/Brick#section-documentation
  • Licenses:
  • Latest release: v1.4.3 (published about 1 month ago)
  • Last Synced: 2025-04-26T14:06:02.129Z (1 day ago)
  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%

Dependencies

requirements.txt pypi
  • black ==22.1.0
  • brickschema >=0.6.1a6
  • docker >=4.3.0
  • flake8 ==3.9.2
  • owlrl >=6.0
  • pre-commit >=2.13.0
  • pyshacl >=0.19
  • pytest >=6.2
  • pytest-xdist *
  • rdflib >=6.1
  • semver >=2.10.1
  • tqdm >=4.46.1
.github/workflows/builds.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v3 composite
.github/workflows/nightly-builds.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • marvinpinto/action-automatic-releases latest composite

Score: -Infinity