Merge branch 'develop' of github.com:NREL/buildingmotif into ts/library_packaging

Author: TShapinsky

docs/README.md

@@ -17,32 +17,6 @@ Currently, ***BuildingMOTIF*** is planned to support [Brick](https://brickschema
 
 # Documentation
 
-The documentation uses Diataxis[^1] as a framework for its structure, which is organized into the following sections.
+[Documentation](https://buildingmotif.readthedocs.io/) is organized into sections for *References*, *Tutorials*, *Guides*, and *Explanations* following the framework Diataxis[^1].
 
 [^1]: https://diataxis.fr/
-
-## Reference
-
-- [Developer Documentation](https://nrel.github.io/BuildingMOTIF/reference/developer_documentation.html)
-- [Command Line Interface](https://nrel.github.io/BuildingMOTIF/reference/cli_tool.html)
-- [Code Documentation](https://nrel.github.io/BuildingMOTIF/reference/apidoc/index.html)
-
-## Tutorials
-
-- [Model Creation](https://nrel.github.io/BuildingMOTIF/tutorials/model_creation.html)
-- [Model Validation](https://nrel.github.io/BuildingMOTIF/tutorials/model_validation.html)
-- [Model Correction](https://nrel.github.io/BuildingMOTIF/tutorials/model_correction.html)
-- [Template Writing](https://nrel.github.io/BuildingMOTIF/tutorials/template_writing.html)
-
-## Guides
-
-- [CSV Import](https://nrel.github.io/BuildingMOTIF/guides/csv-import.html)
-- [Brick model from BACnet network guide](https://nrel.github.io/BuildingMOTIF/guides/bacnet-to-brick.html)
-
-## Explanations
-
-- [Ingresses](https://nrel.github.io/BuildingMOTIF/explainations/ingresses.html)
-
-## Appendix
-
-- [Bibiography](https://nrel.github.io/BuildingMOTIF/bibliography.html)

docs/_config.yml

@@ -3,7 +3,7 @@
 # Book settings
 title                       : BuildingMOTIF Documentation
 author                      : NREL
-copyright                   : "2023"
+copyright                   : "2025"
 logo                        : BuildingMOTIF-logo-rev.svg
 
 # Execution settings
@@ -17,7 +17,7 @@ execute:
 # HTML-specific settings
 html:
   favicon                   : BuildingMOTIF-icon-rev.svg
-  announcement              : "⚠️ This is an BETA release for testing purposes only ⚠️"
+  announcement              : ""
   use_issues_button         : true
   use_repository_button     : true
 

docs/conf.py

@@ -9,7 +9,7 @@
 autosummary_generate = True
 bibtex_bibfiles = ['bibliography.bib']
 comments_config = {'hypothesis': False, 'utterances': False}
-copyright = '2023'
+copyright = '2025'
 exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
 extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinxcontrib.bibtex', 'sphinx_jupyterbook_latex']
 external_toc_exclude_missing = False
@@ -19,7 +19,7 @@
 html_logo = 'BuildingMOTIF-logo-rev.svg'
 html_sourcelink_suffix = ''
 html_theme = 'sphinx_book_theme'
-html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': ''}, 'path_to_docs': 'docs', 'repository_url': 'https://github.com/NREL/BuildingMOTIF', 'repository_branch': 'main', 'extra_footer': '', 'home_page_in_toc': True, 'announcement': '⚠️ This is an BETA release for testing purposes only ⚠️', 'analytics': {'google_analytics_id': ''}, 'use_repository_button': True, 'use_edit_page_button': False, 'use_issues_button': True}
+html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': ''}, 'path_to_docs': 'docs', 'repository_url': 'https://github.com/NREL/BuildingMOTIF', 'repository_branch': 'main', 'extra_footer': '', 'home_page_in_toc': True, 'announcement': '', 'analytics': {'google_analytics_id': ''}, 'use_repository_button': True, 'use_edit_page_button': False, 'use_issues_button': True}
 html_title = 'BuildingMOTIF Documentation'
 latex_engine = 'pdflatex'
 myst_enable_extensions = ['colon_fence', 'dollarmath', 'linkify', 'substitution', 'tasklist']

docs/reference/developer_documentation.md

@@ -3,7 +3,7 @@
 ## Installing
 
 1. Install prerequisites:
-   - [Python >= 3.8.0](https://www.python.org/downloads/)
+   - [Python >= 3.10.0, < 3.13](https://www.python.org/downloads/)
    - [Poetry 1.4.0](https://python-poetry.org/docs/#installation)
 2. Clone this repository.
 3. Change directory to the new `/BuildingMOTIF` directory.
@@ -15,7 +15,7 @@
    ```
 5. Install dependencies and pre-commit.
     ```
-    poetry install --with dev  # includes development dependencies
+    poetry install --with dev # includes development dependencies
     poetry run pre-commit install
     ```
 
@@ -68,8 +68,8 @@ pre-commit run -a
 
 Pre-commit commands can be run individually with the following commands. Configuration of `isort`, `black`, and `mypy` are done in [pyproject.toml](https://github.com/NREL/BuildingMOTIF/blob/develop/pyproject.toml) and configuration of `flake8` is done in [.flake8](https://github.com/NREL/BuildingMOTIF/blob/develop/.flake8).
 ```
-poetry run isort
-poetry run black
+poetry run isort .
+poetry run black .
 poetry run flake8 buildingmotif
 poetry run mypy --install-types --non-interactive --ignore-missing-imports
 ```

docs/tutorials/model_correction.md

@@ -51,7 +51,6 @@ constraints = Library.load(ontology_graph="constraints/constraints.ttl")
 brick = Library.load(ontology_graph="../../libraries/brick/Brick-subset.ttl")
 g36 = Library.load(directory="../../libraries/ashrae/guideline36")
 
-
 # load tutorial 2 model and manifest
 model.graph.parse("tutorial2_model.ttl", format="ttl")
 manifest = Library.load(ontology_graph="tutorial2_manifest.ttl")
@@ -123,13 +122,13 @@ ahu_name = "Core_ZN-PSC_AC"
 
 # lookup for the name of the template to the name of the point or part
 points_and_parts = {
-    "resolve_Core_ZN-PSC_ACMixed_Air_Temperature_Sensor": "-MAT",
-    "resolve_Core_ZN-PSC_ACFilter_Differential_Pressure_Sensor": "-FilterDPS",
-    "resolve_Core_ZN-PSC_ACCooling_Command": "-CCmd",
-    "resolve_Core_ZN-PSC_ACHeating_Command": "-HCmd",
-    "resolve_Core_ZN-PSC_ACOutside_Air_Temperature_Sensor": "-OAT",
-    "resolve_Core_ZN-PSC_ACSupply_Air_Temperature_Sensor": "-SAT",
-    "resolve_Core_ZN-PSC_ACReturn_Air_Temperature_Sensor": "-RAT",
+    "resolveCore_ZN-PSC_ACMixed_Air_Temperature_Sensor": "-MAT",
+    "resolveCore_ZN-PSC_ACFilter_Differential_Pressure_Sensor": "-FilterDPS",
+    "resolveCore_ZN-PSC_ACCooling_Command": "-CCmd",
+    "resolveCore_ZN-PSC_ACHeating_Command": "-HCmd",
+    "resolveCore_ZN-PSC_ACOutside_Air_Temperature_Sensor": "-OAT",
+    "resolveCore_ZN-PSC_ACSupply_Air_Temperature_Sensor": "-SAT",
+    "resolveCore_ZN-PSC_ACReturn_Air_Temperature_Sensor": "-RAT",
     "resolveCore_ZN-PSC_ACsa-fan": "-Fan", # this is an existing fan in the model!
 }
 

docs/tutorials/model_creation.md

@@ -85,7 +85,7 @@ Currently, libraries in `../../buildingmotif/libraries/` are *included* and libr
 ```{code-cell}
 # load a library
 from buildingmotif.dataclasses import Library
-brick = Library.load(ontology_graph="../../libraries/brick/Brick-full.ttl")
+brick = Library.load(ontology_graph="../../libraries/brick/Brick-subset.ttl")
 
 # print the first 10 templates
 print("The Brick library contains the following templates:")
@@ -120,7 +120,7 @@ You should not load ontologies, schemas, rules, etc. into a Model. These belong
 
 It is also possible to import RDF graphs into a `Model`.
 
-If you already have an in-memory `RDFlib.Graph` object available (e.g. through an [Graph Ingress](/guides/ingresses) or loading in a Turtle file), just use `Model.add_graph`:
+If you already have an in-memory `RDFlib.Graph` object available (e.g. through an [Graph Ingress](../explanations/ingresses) or loading in a Turtle file), just use `Model.add_graph`:
 
 ```{code-cell}
 import rdflib

docs/tutorials/model_validation.md

@@ -106,7 +106,7 @@ Here is the header of a manifest file. This should also suffice for most of your
 @prefix : <urn:my_site_constraints/> .
 
 : a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.3/Brick>,
+    owl:imports <https://brickschema.org/schema/1.4/Brick>,
                 <https://nrel.gov/BuildingMOTIF/constraints>,
                 <urn:ashrae/g36> .
 ```
@@ -183,7 +183,7 @@ with open("tutorial1_manifest.ttl", "w") as f:
 @prefix : <urn:my_site_constraints/> .
 
 : a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.3/Brick>,
+    owl:imports <https://brickschema.org/schema/1.4/Brick>,
                 <https://nrel.gov/BuildingMOTIF/constraints>,
                 <urn:ashrae/g36> .
 

docs/tutorials/tutorial1_manifest.ttl

@@ -6,7 +6,7 @@
 @prefix : <urn:my_site_constraints/> .
 
 : a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.3/Brick>,
+    owl:imports <https://brickschema.org/schema/1.4/Brick>,
                 <https://nrel.gov/BuildingMOTIF/constraints>,
                 <urn:ashrae/g36> .
 

docs/tutorials/tutorial2_manifest.ttl

@@ -6,7 +6,7 @@
 @prefix : <urn:my_site_constraints/> .
 
 : a owl:Ontology ;
-    owl:imports <https://brickschema.org/schema/1.3/Brick>,
+    owl:imports <https://brickschema.org/schema/1.4/Brick>,
                 <https://nrel.gov/BuildingMOTIF/constraints>,
                 <urn:ashrae/g36> .
 

libraries/brick/Brick-subset.ttl

@@ -4,7 +4,7 @@
 @prefix sh: <http://www.w3.org/ns/shacl#> .
 @prefix skos: <http://www.w3.org/2004/02/skos/core#> .
 
-<https://brickschema.org/schema/1.3/Brick> a owl:Ontology .
+<https://brickschema.org/schema/1.4/Brick> a owl:Ontology .
 
 brick:Acceleration_Time_Setpoint a owl:Class,
         sh:NodeShape ;
@@ -4970,4 +4970,9 @@ brick:Valve_Position_Command a owl:Class,
 brick:Damper a owl:Class,
         sh:NodeShape ;
     rdfs:label "Damper" ;
-    rdfs:subClassOf brick:HVAC_Equipment .
+    rdfs:subClassOf brick:HVAC_Equipment .
+
+brick:Outside_Damper a owl:Class,
+        sh:NodeShape ;
+    rdfs:label "Outside Damper" ;
+    rdfs:subClassOf brick:Damper .