Skip to content

Small office prototype building level 2 audit notebook and example #445

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.

Sign up for GitHub

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

Merged
JieXiong9119 merged 6 commits into from
Jun 30, 2022
Merged

Small office prototype building level 2 audit notebook and example #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
40bf1ff
Draft notebook and example output xml
JieXiong9119 May 31, 2022
a0ad8d5
Update notebook with OS simulation
JieXiong9119 Jun 10, 2022
808778a
Update example
JieXiong9119 Jun 28, 2022
ab8f5d9
Update example
JieXiong9119 Jun 28, 2022
5985a98
Update md
JieXiong9119 Jun 29, 2022
00fabf3
Merge branch 'develop-v2' into small-office-energy-audit-level-2
JieXiong9119 Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/notebooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Here you can find Jupyter Notebooks which serve as guides for using BuildingSync. Currently there is only one notebook for a small office building with a Level 1 energy audit.
Here you can find Jupyter Notebooks which serve as guides for using BuildingSync. Currently there are several notebooks for prototype small office and primary school buildings with ASHRAE Level 1 and 2 energy audit.

# Setup

- `pip install poetry`
- `poetry install`
- `poetry run jupyter lab`

Navigate to the `bsync_examples/Small-Office-Level-1.md`, right click on the file and select `Open With -> Jupytext Notebook`, then walk through the example.
Navigate to the notebook examples (e.g. `bsync_examples/Small-Office-Level-1.md`), right click on the file and select `Open With -> Jupytext Notebook`, then walk through the example.
4 changes: 2 additions & 2 deletions docs/notebooks/bsync_examples/Small-Office-Level-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ By the end of this notebook, you should:
- Create a minimum viable Level 1 BuildingSync document and verify it validates using the [BuildingSync Use Case Validator](https://buildingsync.net/validator)

## For Reference: Core Concepts and Notation Used
- We will be using BuildingSync version 2.3.0. [Documentation](https://buildingsync.net/documentation/2.3.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.3.0).
- We will be using BuildingSync version 2.4.0. [Documentation](https://buildingsync.net/documentation/2.4.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.4.0).
- BuildingSync is an XML Schema Document (XSD). It defines intended structure. Referring to something as a BuildingSync document typically means the document is intended to conform to the BuildingSync schema.
- An XSD defines a hierarchical or tree-based schema, where elements are 'nested' within other elements. An XML document then looks like nested elements within one another. Similar to HTML, it uses angle brackets `<` and `>` to open and close an element tag. The example below provides a very simple example of an XML document:
```xml
Expand Down Expand Up @@ -1452,7 +1452,7 @@ Use the line below to write the file to disk


```python
bsync_dump(root)
bsync_dump(root, file='example-smalloffice-level1.xml')
```


Expand Down
Loading