search

BrickSchema / Brick

Uniform metadata schema for buildings
http://brickschema.org/
BSD 3-Clause "New" or "Revised" License
293 stars 79 forks source link

versioning instance models #370

Closed epaulson closed 1 month ago

epaulson commented 2 years ago

This is just a placeholder, but as part of #350 we should also add as a best practice always including some kind of version info in your Brick models. e.g. something like, for 'mybldg.ttl':

# mybldg.ttl
@prefix bldg: <urn:example#> .
@prefix brick: <https://brickschema.org/schema/Brick#> .

<urn:example#> a owl:Ontology ;
    owl:imports <https://brickschema.org/schema/1.2/Brick#> .

We'd change the brick tooling to do this automatically for people who use the brick tooling, e.g. py-brickschema always adds that to new Brick graphs.

We had a longer discussion about this in the tools working group: https://github.com/BrickSchema/Brick/wiki/Tooling-Working-Group-Notes

jbkoh commented 2 years ago

What do we need to do in Brick ontology for this one?

gtfierro commented 2 years ago

Initial support for this feature here: https://github.com/BrickSchema/py-brickschema/pull/86/

I don't know if there's much in Brick itself that we need to do, save for documenting this pattern in the docs repo (which I will do soon)

efjerb commented 1 month ago

Hi I'm starting up a model that includes some BRICK metadata. Is this still best practice, if I want to show which version the model was built with?

gtfierro commented 1 month ago

Yes! We wrote up a bit of that here: https://docs.brickschema.org/lifecycle/versioning.html

You can check out a table of versions here, too: https://brickschema.org/resources/

Brick 1.4 will redirect to the latest 1.4.x model (1.4.2 in this case)

efjerb commented 1 month ago

Oh my, I keep overlooking content in the documentation.... Thanks for your answer!