deploy: 282ef2f

NREL · Sep 16, 2024 · 3da73e7 · 3da73e7
1 parent 39cd397
commit 3da73e7
Show file tree

Hide file tree

Showing 105 changed files with 2,253 additions and 1,179 deletions.
diff --git a/.doctrees/README.doctree b/.doctrees/README.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/explanations/point-label-parsing.doctree b/.doctrees/explanations/point-label-parsing.doctree
diff --git a/.doctrees/explanations/shapes-and-templates.doctree b/.doctrees/explanations/shapes-and-templates.doctree
diff --git a/.doctrees/guides/generating-queries.doctree b/.doctrees/guides/generating-queries.doctree
diff --git a/.doctrees/guides/ingress-bacnet-to-brick.doctree b/.doctrees/guides/ingress-bacnet-to-brick.doctree
diff --git a/.doctrees/tutorials/model_creation.doctree b/.doctrees/tutorials/model_creation.doctree
diff --git a/README.html b/README.html
@@ -256,6 +256,7 @@
 <li class="toctree-l1"><a class="reference internal" href="explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/api/app.html b/_modules/buildingmotif/api/app.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/api/views/library.html b/_modules/buildingmotif/api/views/library.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/api/views/model.html b/_modules/buildingmotif/api/views/model.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/api/views/template.html b/_modules/buildingmotif/api/views/template.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/building_motif/building_motif.html b/_modules/buildingmotif/building_motif/building_motif.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/building_motif/singleton.html b/_modules/buildingmotif/building_motif/singleton.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/database/graph_connection.html b/_modules/buildingmotif/database/graph_connection.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/database/table_connection.html b/_modules/buildingmotif/database/table_connection.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/database/tables.html b/_modules/buildingmotif/database/tables.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/database/utils.html b/_modules/buildingmotif/database/utils.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/dataclasses/library.html b/_modules/buildingmotif/dataclasses/library.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/dataclasses/model.html b/_modules/buildingmotif/dataclasses/model.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/dataclasses/shape_collection.html b/_modules/buildingmotif/dataclasses/shape_collection.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/dataclasses/template.html b/_modules/buildingmotif/dataclasses/template.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">
@@ -747,7 +748,15 @@ <h1>Source code for buildingmotif.dataclasses.template</h1><div class="highlight
                 <span class="n">deptempl_opt_args</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">deptempl</span><span class="o">.</span><span class="n">parameters</span><span class="p">)</span>
 
             <span class="c1"># convert our set of optional params to a list and assign to the parent template</span>
-            <span class="n">templ</span><span class="o">.</span><span class="n">optional_args</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">templ_optional_args</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">deptempl_opt_args</span><span class="p">))</span>
+            <span class="c1"># 1. get required parameters from the original template</span>
+            <span class="c1"># 2. calculate all optional requirements from the dependency template and the original template</span>
+            <span class="c1"># 3. remove required parameters from the optional requirements</span>
+            <span class="c1"># This avoids a bug where an optional dependency makes reference to a required parameter, and then</span>
+            <span class="c1"># subsequent inlining of the dependency without optional args would remove the required parameter</span>
+            <span class="n">required</span> <span class="o">=</span> <span class="n">templ</span><span class="o">.</span><span class="n">parameters</span> <span class="o">-</span> <span class="n">templ_optional_args</span>
+            <span class="n">templ</span><span class="o">.</span><span class="n">optional_args</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span>
+                <span class="n">templ_optional_args</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">deptempl_opt_args</span><span class="p">)</span> <span class="o">-</span> <span class="n">required</span>
+            <span class="p">)</span>
 
             <span class="c1"># append the inlined template into the parent&#39;s body</span>
             <span class="n">templ</span><span class="o">.</span><span class="n">body</span> <span class="o">+=</span> <span class="n">deptempl</span><span class="o">.</span><span class="n">body</span>

diff --git a/_modules/buildingmotif/dataclasses/validation.html b/_modules/buildingmotif/dataclasses/validation.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/bacnet.html b/_modules/buildingmotif/ingresses/bacnet.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/base.html b/_modules/buildingmotif/ingresses/base.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/brick.html b/_modules/buildingmotif/ingresses/brick.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/csvingress.html b/_modules/buildingmotif/ingresses/csvingress.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/naming_convention.html b/_modules/buildingmotif/ingresses/naming_convention.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/template.html b/_modules/buildingmotif/ingresses/template.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/ingresses/xlsx.html b/_modules/buildingmotif/ingresses/xlsx.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/label_parsing/combinators.html b/_modules/buildingmotif/label_parsing/combinators.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/label_parsing/parser.html b/_modules/buildingmotif/label_parsing/parser.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">

diff --git a/_modules/buildingmotif/label_parsing/tokens.html b/_modules/buildingmotif/label_parsing/tokens.html
@@ -254,6 +254,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/templates.html">Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shapes-and-templates.html">Shapes and Templates</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../explanations/shacl_to_sparql.html">SHACL to SPARQL Conversion</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../explanations/point-label-parsing.html">Point Label Parsing</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
 <ul class="nav bd-sidenav">