brickschema/reconciliation-api

Implementation of the W3C Reconciliation Service (https://reconciliation-api.github.io/specs/0.1/) for OpenRefine and other tools

Reconciliation APIs

Note: there is a publicly hosted instance of this running at https://reconciliation.brickschema.org/reconcile . You can input that URL directly into OpenRefine

This holds Reconciliation API implementations (compliant to https://reconciliation-api.github.io/specs/0.1/) for use with OpenRefine and other software supporting the reconciliation API standard.

This Reconciliation API implementation enables the inference of Brick equipment and point classes from unstructured BMS labels. If you want to learn how to use this tool to create Brick models, check out our tutorial video.

How to Install Reconciliation Server

You will only need to set this up once before you can use the Reconciliatio nserver

1. Make sure you have an OpenRefine server running
2. Make sure you have Python 3 (at least version 3.6) installed
3. Set up virtual environment and install dependencies for the reconciliation server:
   1. Navigate to the reconciliation-apis directory in your terminal
   2. Run python3 -m venv venv (creates virtual environment) (only need to do this once)
   3. Run source venv/bin/activate (activates virtual environment)
   4. Run pip install -r requirements.txt (installs dependencies) (only need to do this once)
4. Run the server: python3 app.py:
   • If you need to stop/restart the server, remember to activate the virtual environment before running this command
5. From the OpenRefine web interface (link here), open up a CSV file as you would normally, and use the drop down menu for any column to select "Reconcile" and then "Start Reconciling"
6. This should have opened a new modal window. Select "Add Standard Service" in the lower left corner of this window and enter http://localhost:5000/reconcile into the text box. This address is produced by the default address of the reconciliation server (open app.py to change the port) followed by the /reconcile path, which is the endpoint that supports the reconciliation API. This should now appear as the "Brick Reconciliation Service" in the modal.
7. Use the "Brick Reconciliation Service" as suggested in the YouTube tutorial

reconciliation-api's Issues

Support Brick v1.2

Hi @gtfierro, can I configure the server to make the reconcile services using Brick version 1.2 ? Since my iBMS point have some condenser sensor which only included in version 1.2, thanks!

Missing rdf namespace

Hi @gtfierro, when I use make.py to convert, the ttl file are missing rdf namespace even I put it in template txt, the output ttl file only have brick and building namespace.

How to make a better guess about Brick Class by changing abbreviation mapping

Hello,
When I try to convert the CSV to brick model, I found that there have different accuracy if I split the column into a different number of column, for example:

Some metadata split into 1 column can make a better guess

Some metadata split into 2 columns can make a better guess

I am thinking it may be the abbreviation mapping does not contain the data about "AUTO" in image 2, so I am trying to expand the abbreviation mapping in abbrmap.py.
If I want to add some data on it to make a better guess about Brick Class by changing abbreviation mapping
What should I do and anythings or rules I need to pay attention to?