bim2rdf 2025.9.1830

Convert BIM data to RDF models

BIM2RDF

Functionality used to convert building models in Speckle to ASHRAE S223 semantic models. The operationalized version will be on Speckle Automate.

Each top-level directory is a 'component' of the project. Furthermore, the following dependencies were extracted as generic stand-alone libraries: PyTQSHACL, RDF-Engine, JSON2RDF.

Development

Setup

> uv sync --all-packages
> uv run pre-commit install
# activate environment
> .venv/Scripts/activate

Make a .secrets.toml file with

[speckle]
token = "yourtoken"

In development, a .cache directory will be created in the working directory to save expensive processing in general but mainly to save Speckle query results. Thus, the user must clear the cache to be able to access new data.

Process

Follow test instructions.

Usage

...is a three-step process:

1. Get an ontology. You can use the built-in process, bim2rdf ontologies.import followed by bim2rdf ontologies.import, to create an ontology ttl from a definition.
2. Create mappings.
3. Execute. Configure with a params.yaml.

Interfaces

CLI

bim2rdf --help

Function

from bim2rdf import Run
# initialize with a db
from pyoxigraph import Store
db = Store()
r = Run(db)
# execute with desired options
help(Run.run)