SHACL Shapes DataBase

A database of SHACL constraints for checking conformance of meta-data of heterogeneous resources in AEC projects
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This repository contains all the SHACL Shapes created as a part of the BIM4Ren project and my PhD thesis. All shapes are modularized and contain namespaces used in the thesis. The aim of this database is to facilitate reuseable SHACL shapes for automated checking of Linked Building Data in AEC projects. The SHACL Shapes can be used for checking conformance of the following types of resources:

• Meta-data of partial Linked Building Data
• Annotation Meta-data of Images & Documents
• Information container-related meta-data
• Link relationships and their provenances

The ontologies used in the SHACL shapes belong to both the Upper/Foundational Ontologies and Domain Ontologies. For concepts with multiple commonly available terminologies from different ontologies, the SHACL shapes were framed to be applicable, regardless of the ontology used.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• MS Code

(back to top)

Getting Started

Below are the steps for using the SHACL Shapes for checking resource conformity.

Prerequisites

Installation of any SHACL Validation program (either on local machine as a library or use an online service.

Popular validation engines are:

• https://shacl.org/playground/
• https://shacl-play.sparna.fr/play/
• https://jena.apache.org/documentation/shacl/
• https://www.npmjs.com/package/rdf-validate-shacl
• https://www.itb.ec.europa.eu/shacl/any/upload

Depending on the validation program chosen, follow the isntructions for using the shapes from this database

Installation

Below is an example of using SHACL PLAYGROUND (https://shacl.org/playground/) for validation

1. Select a Shapes Graph from the /Shapes folder in this repo.
2. Select an Instance Graph from your own database, or use an example form the /Data folder in this repo.
3. Upload both these graphs in the appropriate spaces in a validator engine.
4. Click on Update button for viewing the validation result.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Madhumitha Senthilvel - @your_twitter - [email protected]

Project Link: https://github.com/sbalot/BIM4Ren_SHACLDB

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• BIM4Ren Research Project

(back to top)