Add BuildingMOTIF examples (#23)

* init commit on bmotif * add headers * adjusting code
open223 · Aug 6, 2024 · 24abd43 · 24abd43
1 parent 125e277
commit 24abd43
Show file tree

Hide file tree

Showing 22 changed files with 332 additions and 0 deletions.
diff --git a/_config.yml b/_config.yml
@@ -9,6 +9,7 @@ logo: ""
 # Execution settings
 execute:
   execute_notebooks: force
+  timeout: 300
 
 # Parse and render settings
 parse:

diff --git a/build_examples.sh b/build_examples.sh
@@ -25,6 +25,7 @@ for filename in examples/*.md; do
     echo "  Writing to $md_filename"
 
     python tools/make_count_table.py "$ttl_filename" "$md_filename"
+    python tools/make-notebook.py "$ttl_filename" "$md_filename"
 done
 
 # build queries

diff --git a/examples/NREL-example.md b/examples/NREL-example.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # NREL Example Building
 
 This is an example building provided by the National Renewable Energy Laboratory, built with the [BuildingMOTIF](https://github.com/NREL/BuildingMOTIF) tool.

diff --git a/examples/bdg1-1.md b/examples/bdg1-1.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # Example Building 1 model 1
 
 Example Building 1 is a simplistic, reference tiny office building consisting of a single story with 5 rooms spanning 5 space types.

diff --git a/examples/bdg1-2.md b/examples/bdg1-2.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # Example Building 1 model 2
 
 Example Building 1 is a simplistic, reference tiny office building consisting of a single story with 5 rooms spanning 5 space types.

diff --git a/examples/design-patterns.md b/examples/design-patterns.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # Design Patterns
 
 This file contains the Turtle code supporting the set of design patterns presented in the User Documentation site, in the section titled ["Modeling Design Patterns"](https://docs.open223.info/guides/design-patterns.html#)

diff --git a/examples/guideline36-2021-A-1.md b/examples/guideline36-2021-A-1.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-1 VAV Terminal Unit, Cooling Only
 
 This component model is an example of the variable air volume (VAV) terminal unit with cooling only from Guideline 36-2021, Appendix A, Figure A-1.

diff --git a/examples/guideline36-2021-A-2.md b/examples/guideline36-2021-A-2.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-2 VAV Terminal Unit with Reheat
 
 This component model is an example of the variable air volume (VAV) terminal unit with reheat from Guideline 36-2021, Appendix A, Figure A-2.

diff --git a/examples/guideline36-2021-A-3.md b/examples/guideline36-2021-A-3.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-3 Parallel Fan-Powered Terminal Unit, Constant Volume Fan
 
 This component model is an example of the parallel fan-powered terminal unit with constant volume fan from Guideline 36-2021, Appendix A, Figure A-3.

diff --git a/examples/guideline36-2021-A-4.md b/examples/guideline36-2021-A-4.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-4 Parallel Fan-Powered Terminal Unit, Variable Volume Fan
 
 This component model is an example of the parallel fan-powered terminal unit with variable volume fan from Guideline 36-2021, Appendix A, Figure A-4.

diff --git a/examples/guideline36-2021-A-7.md b/examples/guideline36-2021-A-7.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-7 Dual Duct Terminal Unit with Inlet Sensors
 
 This component model is an example of the dual duct terminal unit with inlet sensors from Guideline 36-2021, Appendix A, Figure A-7.

diff --git a/examples/guideline36-2021-A-8.md b/examples/guideline36-2021-A-8.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-8 Dual Duct Terminal Unit with Discharge Sensor
 
 This component model is an example of the dual duct terminal unit with discharge sensor from Guideline 36-2021, Appendix A, Figure A-8.

diff --git a/examples/guideline36-2021-A-9.md b/examples/guideline36-2021-A-9.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # ASHRAE Guideline 36-2021 A-9 Multiple Zone VAV Air Handling Unit
 
 This component model is an example of the multiple zone VAV air handling unit _with return fan and OA measurement station_ from Guideline 36-2021, Appendix A, Figure A-9.

diff --git a/examples/lbnl-example-2.md b/examples/lbnl-example-2.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # LBNL Example Building 2
 
 This is a reference model provided by LBNL of a medium-sized office building with two office floors. It uses an underfloor air distribution system with fan-powered terminal reheat coils for perimeter zones. Four roof-top units with VAV are located on the roof. Labels have been anonymized, and are not interpretable.

diff --git a/examples/lbnl-example-radiant.md b/examples/lbnl-example-radiant.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # LBNL Example SMB Radiant
 
 This is a reference model provided by LBNL of a medium office building using a radiant system. Labels have been anonymized, and may not be interpretable.

diff --git a/examples/lbnl-example.md b/examples/lbnl-example.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # LBNL Example Building
 
 This is an example building provided by Lawrence Berkeley National Laboratory

diff --git a/examples/model.md b/examples/model.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # Example model
 
 Vis of a model, description of a model, description of queries, etc. 

diff --git a/examples/nist-example.md b/examples/nist-example.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # NIST Example Building
 
 This is a model of the Intelligent Buildings Agents Laboratory (IBAL) at NIST.

diff --git a/examples/pnnl-example2.md b/examples/pnnl-example2.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # PNNL Example Building 2
 
 This is an example building model provided by Pacific Northwest National Laboratory.

diff --git a/examples/scb-rtu.md b/examples/scb-rtu.md
@@ -1,3 +1,14 @@
+---
+jupytext:
+  formats: md:myst
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
 # LBNL Example SCB RTU
 
 This is a reference model provided by LBNL of a small office building using two individually zoned Rooftop HVAC Units. Labels have been anonymized, and may not be interpretable.

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,31 @@
+[project]
+name = "models-open223-info"
+version = "0.1.0"
+description = "Add your description here"
+authors = [
+    { name = "Gabe Fierro", email = "[email protected]" }
+]
+dependencies = [
+    "jupyter-book>=0.15.1",
+    "toml>=0.10.2",
+    "sphinxcontrib-mermaid>=0.9.2",
+    "rdflib>=7.0.0",
+    "pyontoenv==0.1.9a3",
+    "brickschema==0.7.4a9",
+    "nbformat>=5.10.4",
+    "jupyterlab>=4.2.4",
+    "buildingmotif[topquadrant] @ git+https://github.com/NREL/buildingmotif.git@develop"
+]
+readme = "README.md"
+requires-python = ">= 3.11"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true