SHACL-based validation BIM Bot

Thomas Krijnen [email protected]

An implementation of a BIM-Bot that accepts Linked-data serialized Bim4ren models, applies several SHACL shapes and returns output as a BCF. Can be ran as a BIM Bot or HTML web-interface.

The repository of SHACL shapes is a git submodule in this repository. So, either

git clone --recursive

or do after cloning

git submodule init && git submodule update

Overview

• invoke.py invokes the running BIM bot and interactively shows the information exchange
• main.py the main Flask entrypoint and BCF serialization
• run_validate.py the functionality to invoke SHACL, parse the output and join with the input graph to construct {guid, message} pairs
• templates/index.html Jinja2 template for the HTML frontend
• Dockerfile for production usage of the server
• run.sh for building and running with the appropriate port binding
• supervisord.conf configuration of the programs for production usage
• wsgi.py WSGI wrapper for gunicorn

Example usage

$ python3 invoke.py
> POST http://localhost HTTP/1.1
> User-Agent: python-requests/2.22.0
> Accept-Encoding: gzip, deflate
> Accept: */*
> Connection: keep-alive
> Content-Length: 96189
> Content-Type: application/json
>
> {'inputs': [{'identifier': 'BIM4Ren_DUNANT_cleaned_IFC2x3',
>              'location': 'data:text/turtle;base64,QHByZWZpeCBnZW86ICAgPGh...',
>              'schema': 'B4R',
>              'type': 'RDF'}],
>  'outputs': [{'location': 'embedded', 'schema': 'BCF_ZIP_2_0', 'type': 'FILE'}]}


< Server: gunicorn
< Date: Sat, 27 Mar 2021 11:28:19 GMT
< Connection: close
< Content-Type: application/json
< Content-Length: 38842
<
< {'location': 'data:application/octet-stream;base64,UEsDBBQAAA...',
<  'schema': 'BCF_ZIP_2_0',
<  'type': 'FILE'}



BCF contents:
./bcf.version
./4b0b257f-e9f6-46c0-8e7e-202474cae6df/markup.bcf
./4b0b257f-e9f6-46c0-8e7e-202474cae6df/Viewpoint_7e50795e-101a-40b8-9a3b-a89e6b370d2a.bcfv
./b265bbdf-8e2d-4432-b583-51977b55fdcd/markup.bcf
./b265bbdf-8e2d-4432-b583-51977b55fdcd/Viewpoint_a8764071-1b04-4e12-afe2-d4fab9ae88ae.bcfv

Development

Install the requirements.

python -m pip install -r requirements.txt

Download and unzip shacl into the root directory of this repository

https://repo1.maven.org/maven2/org/topbraid/shacl/1.3.2/shacl-1.3.2-bin.zip

Spin op a development server with automatic code reloading.

python main.py

When the server is running invoke with example usage

python invoke.py 5000

Or open your webbrowser with

localhost:5000

Production

The application can be deployed as a Docker file that runs supervisord to monitor the gunicorn web server and a process that polls for new changes in the repository of validation shapes. Building the Docker file and running with the appropriate port binding can be accomplished by running run.sh