Notebooks protobuildings by ThibaultMarzullo · Pull Request #447 · BuildingSync/schema

ThibaultMarzullo · 2022-06-24T22:15:33Z

Any background context you want to provide?

The Documentation contains Jupyter Notebooks that walk users through the creation of a BSync XML using bsyncpy.
The existing example of a L100 audit in a DOE Prototype small office building was expanded to include a L200 audit of the same building, and both a L100 and L200 audit of the DOE Prototype primary school building.

What does this PR do?

It adds the L100 and L200 examples for the DOE Prototype primary school building

How should this be manually tested?

Review the notebook. Generate the two .xml files. Replace the XML headers to specify the correct namespaces. Upload them to the Schema Validator.

What are the relevant tickets?

Reference implementations of 2 DOE prototype buildings in BuildingSync 2.4

Screenshots (if appropriate)

school prototype building

ThibaultMarzullo · 2022-06-24T22:17:29Z

@nllong @JieXiong9119 , I have some cleaning up to do on that. Can you verify the code part and kindly ignore the text for the moment? I have some descriptions to write near the end of the document and some section numbers to verify.
Also, POM values are made up and I will update with simulated values.
Thanks!

ThibaultMarzullo · 2022-06-27T21:26:10Z

@laurenliz22 , the text has been updated! I think it is ready for review

laurenliz22

@ThibaultMarzullo This is awesome, thank you for all of your hard work. I added in a few comments - do you mind looking through and letting me know if you have any questions. Thank you!!

Updated the XML examples. Removed older markdown file.

ThibaultMarzullo · 2022-06-29T20:45:26Z

@laurenliz22 Thank you, I have committed the corrected version following your review. I have not added a ReadMe file as Jie already created a single ReadMe for the whole bsync_examples folder that mentions the primary school example.

laurenliz22

Looks great! Thanks Thibault!

nllong

this is great. There are some orthographic updates, but they aren't required to merge.

I do think one item that we need to solve is how to make these new BuildingSync files cover more than just Level 1 and Level 2 Use Cases (as seen by the Validation Tool)? Will these files upload to Audit Template, if not, what is missing? How can we make these work with SEED (looks like that use case was also a red X)?

Good work diving in and dealing with very detailed models!

nllong · 2022-06-30T16:03:02Z

+
+## 4. Setting up the root of the BuildingSync file
+
+We are going to define the basic building blocks (ha!) of our representation of the primary school prototype building. For that, we need to define a buiding, which belongs to a site, which belongs to a facility, which belongs to the highest-level of our BuildingSync file: the BuildingSync root. It will look like this:


nllong · 2022-06-30T16:04:13Z

+
+# xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
+    # xsi:SchemaLocation = "http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd"
+root = bsync.BuildingSync()#**kwargs=xmlargs)


Suggested change

root = bsync.BuildingSync()#**kwargs=xmlargs)

nllong · 2022-06-30T16:04:34Z

+    'xsi:SchemaLocation' : "http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd"
+}
+
+# xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"


Suggested change

# xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"

nllong · 2022-06-30T16:07:51Z

+```python
+# create a new section
+gym_sec = bsync.Sections.Section(ID="Gym")
+gym_sec += bsync.SectionType('Space function')


Suggested change

gym_sec += bsync.SectionType('Space function')

gym_sec += bsync.SectionType("Space function")

this repeats...

nllong · 2022-06-30T16:10:17Z

+# Let us automate the task this time
+# We first create a list of dictionaries that contains information on space IDs and the appropriate plug load. The plug load is taken from the Primary School Prototype ASHRAE Standard 90.1-2016 model
+# We take the IDs from the sections we created earlier
+plugloads = [{'spaceid' : lobby_sec["ID"], 'plugload' : 4.0},


good job on the space functions! I'm wondering if in the future we can create a dict or something that we store all the space function data in first, then just iterate? Similar to your space plugloads here.

Yes, agreed. I'll also do the same for schedules, it's a bit too dense right now IMHO.

No functional changes.

ThibaultMarzullo added 5 commits April 21, 2022 12:19

Primary School proto initial commit

b7157ab

New example for a level 1 audit of the primary

93c1351

school prototype building

Finished L100 audit of the primary school building

4fdf278

Cleanup

f7964e5

Completed XML that passes the L200 validator

328ac67

ThibaultMarzullo added DO NOT MERGE Non-breaking Change Schema: Documentation Update to BuildingSync's documentation/annotations labels Jun 24, 2022

ThibaultMarzullo requested review from JieXiong9119, laurenliz22 and nllong June 24, 2022 22:15

ThibaultMarzullo self-assigned this Jun 24, 2022

Updated text, fixed packages of measures.

bcabcd3