deploy: f5db90f

NREL · Sep 24, 2023 · 763dea9 · 763dea9
1 parent 250425e
commit 763dea9
Show file tree

Hide file tree

Showing 109 changed files with 2,529 additions and 1,513 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8a0fe213fcbc83bed2eac30685788f63
+config: 39f4708a50da1a38d14df437e0c00cd1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
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/ingresses.doctree b/.doctrees/explanations/ingresses.doctree
diff --git a/.doctrees/guides/csv-import.doctree b/.doctrees/guides/csv-import.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/reference/apidoc/_autosummary/buildingmotif.database.table_connection.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.database.table_connection.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.model.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.model.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.shape_collection.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.shape_collection.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.validation.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.validation.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.template_compilation.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.template_compilation.doctree
diff --git a/.doctrees/reference/cli_tool.doctree b/.doctrees/reference/cli_tool.doctree
diff --git a/.doctrees/reference/developer_documentation.doctree b/.doctrees/reference/developer_documentation.doctree
diff --git a/.doctrees/tutorials/model_correction.doctree b/.doctrees/tutorials/model_correction.doctree
diff --git a/.doctrees/tutorials/model_creation.doctree b/.doctrees/tutorials/model_creation.doctree
diff --git a/.doctrees/tutorials/model_validation.doctree b/.doctrees/tutorials/model_validation.doctree
diff --git a/README.html b/README.html
@@ -63,6 +63,7 @@
 </script>
     <script async="async" src="_static/sphinx-thebe.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'README';</script>
+    <link rel="shortcut icon" href="_static/BuildingMOTIF-icon-rev.svg"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Developer Documentation" href="reference/developer_documentation.html" />
@@ -121,7 +122,7 @@
 
 
   <div class="bd-header-announcement container-fluid bd-header-announcement">
-    <div class="bd-header-announcement__content">⚠️ This is an ALPHA release for testing purposes only ⚠️</div>
+    <div class="bd-header-announcement__content">⚠️ This is an BETA release for testing purposes only ⚠️</div>
   </div>
 
 
@@ -151,8 +152,14 @@
 
 
 
+
+
+
+
+
+    <img src="_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-light" alt="Logo image"/>
+    <script>document.write(`<img src="_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
 
-    <p class="title logo__title">BuildingMOTIF Documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
@@ -168,7 +175,7 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="reference/developer_documentation.html">Developer Documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="reference/cli_tool.html">Command Line Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="reference/cli_tool.html">Command Line Interface</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="reference/apidoc/index.html">Code Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.html">buildingmotif</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3 has-children"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.api.html">buildingmotif.api</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
@@ -438,7 +445,8 @@ <h2> Contents </h2>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#reference">Reference</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tutorials">Tutorials</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#guides">Guides</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#explanation">Explanation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#explanations">Explanations</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#appendix">Appendix</a></li>
 </ul>
 </li>
 </ul>
@@ -474,6 +482,7 @@ <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 <h2>Reference<a class="headerlink" href="#reference" title="Permalink to this heading">#</a></h2>
 <ul class="simple">
 <li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/reference/developer_documentation.html">Developer Documentation</a></p></li>
+<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/reference/cli_tool.html">Command Line Interface</a></p></li>
 <li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/reference/apidoc/index.html">Code Documentation</a></p></li>
 </ul>
 </section>
@@ -489,12 +498,21 @@ <h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this he
 <section id="guides">
 <h2>Guides<a class="headerlink" href="#guides" title="Permalink to this heading">#</a></h2>
 <ul class="simple">
+<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/guides/csv-import.html">CSV Import</a></p></li>
 <li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/guides/bacnet-to-brick.html">Brick model from BACnet network guide</a></p></li>
 </ul>
 </section>
-<section id="explanation">
-<h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to this heading">#</a></h2>
-<p>🏗️ under construction</p>
+<section id="explanations">
+<h2>Explanations<a class="headerlink" href="#explanations" title="Permalink to this heading">#</a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/explainations/ingresses.html">Ingresses</a></p></li>
+</ul>
+</section>
+<section id="appendix">
+<h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this heading">#</a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/bibliography.html">Bibiography</a></p></li>
+</ul>
 <hr class="footnotes docutils" />
 <aside class="footnote brackets" id="id2" role="note">
 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
@@ -572,7 +590,8 @@ <h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to thi
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#reference">Reference</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tutorials">Tutorials</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#guides">Guides</a></li>
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#explanation">Explanation</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#explanations">Explanations</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#appendix">Appendix</a></li>
 </ul>
 </li>
 </ul>
@@ -599,7 +618,7 @@ <h2>Explanation<a class="headerlink" href="#explanation" title="Permalink to thi
 
   <p class="copyright">
 
-      © Copyright 2022.
+      © Copyright 2023.
       <br/>
 
   </p>

diff --git a/_modules/buildingmotif/api/app.html b/_modules/buildingmotif/api/app.html
@@ -62,6 +62,7 @@
 </script>
     <script async="async" src="../../../_static/sphinx-thebe.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/buildingmotif/api/app';</script>
+    <link rel="shortcut icon" href="../../../_static/BuildingMOTIF-icon-rev.svg"/>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
@@ -119,7 +120,7 @@
 
 
   <div class="bd-header-announcement container-fluid bd-header-announcement">
-    <div class="bd-header-announcement__content">⚠️ This is an ALPHA release for testing purposes only ⚠️</div>
+    <div class="bd-header-announcement__content">⚠️ This is an BETA release for testing purposes only ⚠️</div>
   </div>
 
 
@@ -149,8 +150,14 @@
 
 
 
+
+
+
+
+
+    <img src="../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-light" alt="Logo image"/>
+    <script>document.write(`<img src="../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
 
-    <p class="title logo__title">BuildingMOTIF Documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
@@ -166,7 +173,7 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../../reference/developer_documentation.html">Developer Documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../reference/cli_tool.html">Command Line Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../reference/cli_tool.html">Command Line Interface</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../reference/apidoc/index.html">Code Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../../../reference/apidoc/_autosummary/buildingmotif.html">buildingmotif</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../reference/apidoc/_autosummary/buildingmotif.api.html">buildingmotif.api</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
@@ -499,7 +506,7 @@ <h1>Source code for buildingmotif.api.app</h1><div class="highlight"><pre>
 
   <p class="copyright">
 
-      © Copyright 2022.
+      © Copyright 2023.
       <br/>
 
   </p>

diff --git a/_modules/buildingmotif/api/views/library.html b/_modules/buildingmotif/api/views/library.html
@@ -62,6 +62,7 @@
 </script>
     <script async="async" src="../../../../_static/sphinx-thebe.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/buildingmotif/api/views/library';</script>
+    <link rel="shortcut icon" href="../../../../_static/BuildingMOTIF-icon-rev.svg"/>
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
@@ -119,7 +120,7 @@
 
 
   <div class="bd-header-announcement container-fluid bd-header-announcement">
-    <div class="bd-header-announcement__content">⚠️ This is an ALPHA release for testing purposes only ⚠️</div>
+    <div class="bd-header-announcement__content">⚠️ This is an BETA release for testing purposes only ⚠️</div>
   </div>
 
 
@@ -149,8 +150,14 @@
 
 
 
+
+
+
+
+
+    <img src="../../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-light" alt="Logo image"/>
+    <script>document.write(`<img src="../../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
 
-    <p class="title logo__title">BuildingMOTIF Documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
@@ -166,7 +173,7 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../../../reference/developer_documentation.html">Developer Documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../reference/cli_tool.html">Command Line Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../reference/cli_tool.html">Command Line Interface</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../reference/apidoc/index.html">Code Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../../../../reference/apidoc/_autosummary/buildingmotif.html">buildingmotif</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../../reference/apidoc/_autosummary/buildingmotif.api.html">buildingmotif.api</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
@@ -505,7 +512,7 @@ <h1>Source code for buildingmotif.api.views.library</h1><div class="highlight"><
 
   <p class="copyright">
 
-      © Copyright 2022.
+      © Copyright 2023.
       <br/>
 
   </p>

diff --git a/_modules/buildingmotif/api/views/model.html b/_modules/buildingmotif/api/views/model.html
@@ -62,6 +62,7 @@
 </script>
     <script async="async" src="../../../../_static/sphinx-thebe.js"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/buildingmotif/api/views/model';</script>
+    <link rel="shortcut icon" href="../../../../_static/BuildingMOTIF-icon-rev.svg"/>
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
@@ -119,7 +120,7 @@
 
 
   <div class="bd-header-announcement container-fluid bd-header-announcement">
-    <div class="bd-header-announcement__content">⚠️ This is an ALPHA release for testing purposes only ⚠️</div>
+    <div class="bd-header-announcement__content">⚠️ This is an BETA release for testing purposes only ⚠️</div>
   </div>
 
 
@@ -149,8 +150,14 @@
 
 
 
+
+
+
+
+
+    <img src="../../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-light" alt="Logo image"/>
+    <script>document.write(`<img src="../../../../_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-dark" alt="Logo image"/>`);</script>
 
-    <p class="title logo__title">BuildingMOTIF Documentation</p>
 
 </a></div>
         <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
@@ -166,7 +173,7 @@
         <p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../../../reference/developer_documentation.html">Developer Documentation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../reference/cli_tool.html">Command Line Tool</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../reference/cli_tool.html">Command Line Interface</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../../../reference/apidoc/index.html">Code Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2 has-children"><a class="reference internal" href="../../../../reference/apidoc/_autosummary/buildingmotif.html">buildingmotif</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l3 has-children"><a class="reference internal" href="../../../../reference/apidoc/_autosummary/buildingmotif.api.html">buildingmotif.api</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
@@ -562,7 +569,10 @@ <h1>Source code for buildingmotif.api.views.model</h1><div class="highlight"><pr
     <span class="k">return</span> <span class="p">{</span>
         <span class="s2">&quot;message&quot;</span><span class="p">:</span> <span class="n">vaildation_context</span><span class="o">.</span><span class="n">report_string</span><span class="p">,</span>
         <span class="s2">&quot;valid&quot;</span><span class="p">:</span> <span class="n">vaildation_context</span><span class="o">.</span><span class="n">valid</span><span class="p">,</span>
-        <span class="s2">&quot;reasons&quot;</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">reason</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">vaildation_context</span><span class="o">.</span><span class="n">diffset</span><span class="p">],</span>
+        <span class="s2">&quot;reasons&quot;</span><span class="p">:</span> <span class="p">{</span>
+            <span class="n">focus_node</span><span class="p">:</span> <span class="p">[</span><span class="n">gd</span><span class="o">.</span><span class="n">reason</span><span class="p">()</span> <span class="k">for</span> <span class="n">gd</span> <span class="ow">in</span> <span class="n">grahdiffs</span><span class="p">]</span>
+            <span class="k">for</span> <span class="n">focus_node</span><span class="p">,</span> <span class="n">grahdiffs</span> <span class="ow">in</span> <span class="n">vaildation_context</span><span class="o">.</span><span class="n">diffset</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
+        <span class="p">},</span>
     <span class="p">},</span> <span class="n">status</span><span class="o">.</span><span class="n">HTTP_200_OK</span></div>
 </pre></div>
 
@@ -601,7 +611,7 @@ <h1>Source code for buildingmotif.api.views.model</h1><div class="highlight"><pr
 
   <p class="copyright">
 
-      © Copyright 2022.
+      © Copyright 2023.
       <br/>
 
   </p>