Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pnnl example1 model #13

Merged
merged 7 commits into from
Jan 8, 2024
Merged

Conversation

michaelpoplawskipnnl
Copy link
Collaborator

No description provided.

@michaelpoplawskipnnl michaelpoplawskipnnl marked this pull request as ready for review January 4, 2024 02:54
Comment on lines 5 to 6
The model was created using an alpha version of the PNNL Revit2RDF tool that creates a semantic model from a Revit building information model (BIM) exported via a Speckle (https://speckle.systems/) interface.
A Beta version of the Revit2RDF tool will tentatively be released via GitHub sometime in 2024.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The model was created using an alpha version of the PNNL Revit2RDF tool that creates a semantic model from a Revit building information model (BIM) exported via a Speckle (https://speckle.systems/) interface.
A Beta version of the Revit2RDF tool will tentatively be released via GitHub sometime in 2024.

Is this info important and relevant to users?

Copy link
Collaborator Author

@michaelpoplawskipnnl michaelpoplawskipnnl Jan 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so, in particular for the Pritoni model, as we will have at least 2 models for the same building, created via different workflows, modeling different levels of detail, and using different complimentary ontologies: 1) created by Steve, Parastoo, and myself using TopBraid, modeling Mechanical and Electrical/Lighting - including FunctionBlocks, not modeling space types 2) created by PNNL using the Revit2RDF tool, modeling only Electrical/Lighting - but not (yet) including function blocks, and modeling space types using the REC ontology. I talked to Steve Ray about this, and he agreed that it could/should be interesting to users to see multiple models of the same building, and said he would add additional detail to his first draft description to aid in understanding/differentiation.

In general, I think its helpful for users to have some understanding of how the model was created and what is in the model prior to reviewing the model. Also, what's the harm in additional detail?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like knowing that this was created as an export from a BIM model, but I'm reluctant to mention a tool until it's actually available somewhere and we can link to it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, my main concern was what Gabe mentioned, i.e. linking a tool that doesn't exist in the public domain yet. I like the idea of some sort of lineage description of the models but I think it can just be as simple as what the Source was, e.g. BIM, BEM, manual, etc. So maybe a Source heading in the MD file would be a nice addition.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. I'll make some edits, and you can let me know what you think!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MatthewSteen @gtfierro just committed edits to the markdown file. Thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thanks for making the change

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gtfierro thanks! Will one of you make the merge, or can/should I go ahead and do it?

Copy link
Contributor

@MatthewSteen MatthewSteen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me too.

  1. Just one formatting suggestion
  2. Is this a version of the Pritoni model? If so, that should be noted somewhere (file name and/or text) since there will be other Pritoni models here from what I've heard.


Model instance data have a @prefix bdg1: <http://speckle.xyz/streams/1fed8e620e/objects/> that is resolvable to a Speckle URL.

For example, bdg1:05749166d93671bedf16efb52636ce38 a s223:Luminaire resolves to https://speckle.xyz/streams/1fed8e620e/objects/05749166d93671bedf16efb52636ce38.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, bdg1:05749166d93671bedf16efb52636ce38 a s223:Luminaire resolves to https://speckle.xyz/streams/1fed8e620e/objects/05749166d93671bedf16efb52636ce38.
For example, the following resolves to https://speckle.xyz/streams/1fed8e620e/objects/05749166d93671bedf16efb52636ce38.
```ttl
bdg1:05749166d93671bedf16efb52636ce38 a s223:Luminaire

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Matt, it is a version of Pritoni. I will add some mention of that after talking to Steve Ray so we can sync on the sentence that we will both use when describing the origin of this "reference" building. I'm thinking we might not want to just call it the Pritoni building, but rather reference the Metadata schemas journal article as its origin.

Copy link
Contributor

@MatthewSteen MatthewSteen Jan 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sounds good. Also, it would be nice to use the same file name prefix as @steveraysteveray's Pritoni model. I'm assuming this one is more electrical focused and Steve's is mechanical? If that's the case, maybe <new-name>_elec.ttl or similar.

Copy link
Collaborator Author

@michaelpoplawskipnnl michaelpoplawskipnnl Jan 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@steveraysteveray's model is one of the two Pritoni models that were used to explore and demonstrate new concepts, as they were developed by Strike Team Bravo. Parastoo, Steve, and I developed a Pritoni model using TopBraid (referred to as the PSM Pritoni model). Joel and Christian developed a Pritoni model using Bob. At various times the concepts the two models contained were similar, but they were not strictly synchronized.

The PSM Pritoni model contains architecture, mechanical, and lighting/electrical. I think it contains more concepts than any other validated model, at this point.

Our (PNNL)'s tool development has been driven by an attempt to develop a Pritoni model that progresses, over time, to include all the concepts that the PSM Pritoni model includes. We are not there yet, but we aim to get there.

All of this to say, I don't think it makes sense to differentiate the file names by what they represent. The fundamental difference is the development method (TopBraid vs. Revit-based workflow) and the development team (PSM vs. PNNL).

I assume that NREL and LBNL will develop additional example models beyond those currently posted? How are you thinking you will differentiate them? I initially just attempted to match your file naming convention (nrel-example, lbnl-example) and then differentiate by adding a number (example1, example2). There is likely a better way. We will soon have a model for LBNL Bldg 59 and NREL Rail Bldg, and later in the year a model for LBNL Bldg 33. So, there will be more instances of multiple models for the same building.

How about we agree on a numbering convention for each building, and then append the development team to that building number in the file name? The development method and model content (i.e., what systems are modeled) can be described on the model page, as it is now.

For example,

Pritoni = bdg1, filenames = bdg1-psm.ttl, bdg1-pnnl.ttl

Prototype Medium Office = bdg2, filenames = bdg2-pnnl.ttl, bdg2-nrel.ttl (e.g., if you end up creating a model of this building using Building Motif)

LBNL Bldg 59 = bdg3, filenames = bdg3-pnnl.ttl, bdg3-lbnl.ttl

LBNL Bldb 33 = bdg4, filenames = bdg4-pnnl.ttl, bdg4-lbnl.ttl

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, sounds like we should rename files later after agreeing on a convention and more are added.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's some food for thought from the QUDT world. Each of the QUDT graphs contains a reference to metadata information from the ontology instance, such as:

<http://qudt.org/2.1/vocab/unit>  vaem:hasGraphMetadata vaem:GMD_QUDT-UNITS-ALL ;

and here's what we store. We might want to cherry-pick some of these concepts, rather than trying to encode it all in the file name. (Having said that, we do use a file naming convention as well to distinguish schema files from vocabulary files, hence VOCAB_QUDT-UNITS-ALL-v2.1.ttl

vaem:GMD_QUDT-UNITS-ALL
  a vaem:GraphMetaData ;
  dcterms:contributor "Jack Hodges" ;
  dcterms:contributor "Simon J D Cox" ;
  dcterms:contributor "Steve Ray" ;
  dcterms:created "2019-07-30"^^xsd:date ;
  dcterms:creator "Steve Ray" ;
  dcterms:modified "2023-11-15T10:34:16.143-05:00"^^xsd:dateTime ;
  dcterms:rights """
  This product includes all or a portion of the UCUM table, UCUM codes, and UCUM definitions or is derived from it, subject to a license from Regenstrief Institute, Inc. and The UCUM Organization. Your use of the UCUM table, UCUM codes, UCUM definitions also is subject to this license, a copy of which is available at ​http://unitsofmeasure.org. The current complete UCUM table, UCUM Specification are available for download at ​http://unitsofmeasure.org. The UCUM table and UCUM codes are copyright © 1995-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved.

THE UCUM TABLE (IN ALL FORMATS), UCUM DEFINITIONS, AND SPECIFICATION ARE PROVIDED 'AS IS.' ANY EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  """ ;
  dcterms:rights "The QUDT Ontologies are issued under a Creative Commons Attribution 4.0 International License (CC BY 4.0), available at https://creativecommons.org/licenses/by/4.0/. Attribution should be made to QUDT.org" ;
  dcterms:subject "Units-All" ;
  dcterms:title "QUDT Units Version 2.1 Vocabulary" ;
  vaem:description "Standard units of measure for all units." ;
  vaem:graphName "qudt" ;
  vaem:graphTitle "QUDT Units Version 2.1.33" ;
  vaem:hasGraphRole vaem:VocabularyGraph ;
  vaem:hasOwner <http://www.linkedmodel.org/schema/vaem#QUDT.org> ;
  vaem:hasSteward <http://www.linkedmodel.org/schema/vaem#QUDT.org> ;
  vaem:intent "To provide a vocabulary of all units." ;
  vaem:isMetadataFor <http://qudt.org/2.1/vocab/unit> ;
  vaem:latestPublishedVersion "https://qudt.org/doc/2023/11/DOC_VOCAB-UNITS-ALL-v2.1.html"^^xsd:anyURI ;
  vaem:logo "https://qudt.org/linkedmodels.org/assets/lib/lm/images/logos/qudt_logo-300x110.png"^^xsd:anyURI ;
  vaem:namespace "http://qudt.org/vocab/unit/"^^xsd:anyURI ;
  vaem:namespacePrefix "unit" ;
  vaem:owner "QUDT.org" ;
  vaem:previousPublishedVersion "https://qudt.org/doc/2023/10/DOC_VOCAB-UNITS-ALL-v2.1.html"^^xsd:anyURI ;
  vaem:revision "2.1" ;
  vaem:turtleFileURL "http://qudt.org/2.1/vocab/unit"^^xsd:anyURI ;
  vaem:usesNonImportedResource dcterms:abstract ;
  vaem:usesNonImportedResource dcterms:created ;
  vaem:usesNonImportedResource dcterms:creator ;
  vaem:usesNonImportedResource dcterms:modified ;
  vaem:usesNonImportedResource dcterms:title ;
  rdfs:isDefinedBy <http://qudt.org/2.1/vocab/unit> ;
  rdfs:label "QUDT Unit of Measure Vocabulary Metadata Version 2.1.33" ;
.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Christian and I are continuing to work on the CJ model for Pritoni built using Bob (and Wendy, Lofty, and Dizzy) and I'll have a Cornell small office building. I hope there are lots more models to add!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MatthewSteen @gtfierro it sounds like you are okay with the current status of my branch; I will go ahead and merge tonight unless I hear from you. I will also create an Issue to start discussing a new file naming convention, and move my proposal from here to the issue.

@JoelBender good to know. Yes I'm hoping for lots more models too 👍

@steveraysteveray I'm down to experiment with using dcterms and vaem ontologies to add metadata to the shared models. Maybe you and I can develop a minimum proposal for differentiating between the Pritoni models (PSM, CJ, PNNL) next week, and then see what the group thinks?

@michaelpoplawskipnnl michaelpoplawskipnnl merged commit dc0f7e6 into main Jan 8, 2024
1 check passed
@michaelpoplawskipnnl michaelpoplawskipnnl deleted the Add-pnnl-example1-model branch January 11, 2024 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants