BuildingSync / schema

BuildingSync® Schema
https://buildingsync.net
Other
23 stars 22 forks source link

Update notebook for validation against multiple use cases #449

Closed JieXiong9119 closed 1 year ago

JieXiong9119 commented 1 year ago

Any background context you want to provide?

The existing outputs from notebook examples could only be validated against one use case (the corresponding level of audit). There are several use cases that could be satisfied with simple modification to current examples.

What does this PR do?

  1. So now the output example could be validated against these use cases: SEED, L200 Audit, L000 OS Pre-simulation, BRICR SEED

  2. A few corrections on the example data

How should this be manually tested?

What are the relevant tickets?

https://github.com/BuildingSync/project-tracker/issues/119

Screenshots (if appropriate)

JieXiong9119 commented 1 year ago

This PR is trying to enrich the example to cover as many use cases as possible, as to prove the generalisability among different use cases. This effort also shows mutual exclusivity between a few use cases.

The fundamental use case is L200 Audit. The other three use cases could be validated through adding a few elements:

Invalid use cases:

I suggest we should make effort to address the compatibility between this example and L100 Audit use case in the future as they should be intuitively.