deploy: e24d741

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

Hide file tree

Showing 46 changed files with 2,932 additions and 1,566 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
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/reference/apidoc/_autosummary/buildingmotif.api.app.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.api.app.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.api.views.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.api.views.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.api.views.parser.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.api.views.parser.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.library.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.dataclasses.library.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.label_parsing.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.label_parsing.doctree
diff --git a/.doctrees/reference/apidoc/_autosummary/buildingmotif.label_parsing.tokens.doctree b/.doctrees/reference/apidoc/_autosummary/buildingmotif.label_parsing.tokens.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/_modules/buildingmotif/api/app.html b/_modules/buildingmotif/api/app.html
@@ -410,13 +410,15 @@ <h1></h1>
 
   <h1>Source code for buildingmotif.api.app</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
 
 <span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">Flask</span><span class="p">,</span> <span class="n">current_app</span>
 <span class="kn">from</span> <span class="nn">flask_api</span> <span class="kn">import</span> <span class="n">status</span>
 <span class="kn">from</span> <span class="nn">sqlalchemy.exc</span> <span class="kn">import</span> <span class="n">SQLAlchemyError</span>
 
 <span class="kn">from</span> <span class="nn">buildingmotif.api.views.library</span> <span class="kn">import</span> <span class="n">blueprint</span> <span class="k">as</span> <span class="n">library_blueprint</span>
 <span class="kn">from</span> <span class="nn">buildingmotif.api.views.model</span> <span class="kn">import</span> <span class="n">blueprint</span> <span class="k">as</span> <span class="n">model_blueprint</span>
+<span class="kn">from</span> <span class="nn">buildingmotif.api.views.parser</span> <span class="kn">import</span> <span class="n">blueprint</span> <span class="k">as</span> <span class="n">parsers_blueprint</span>
 <span class="kn">from</span> <span class="nn">buildingmotif.api.views.template</span> <span class="kn">import</span> <span class="n">blueprint</span> <span class="k">as</span> <span class="n">template_blueprint</span>
 <span class="kn">from</span> <span class="nn">buildingmotif.building_motif.building_motif</span> <span class="kn">import</span> <span class="n">BuildingMOTIF</span>
 
@@ -453,26 +455,31 @@ <h1>Source code for buildingmotif.api.app</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="p">),</span> <span class="n">status</span><span class="o">.</span><span class="n">HTTP_500_INTERNAL_SERVER_ERROR</span>
 
 
-<div class="viewcode-block" id="create_app"><a class="viewcode-back" href="../../../reference/apidoc/_autosummary/buildingmotif.api.app.html#buildingmotif.api.app.create_app">[docs]</a><span class="k">def</span> <span class="nf">create_app</span><span class="p">(</span><span class="n">DB_URI</span><span class="p">):</span>
+<div class="viewcode-block" id="create_app"><a class="viewcode-back" href="../../../reference/apidoc/_autosummary/buildingmotif.api.app.html#buildingmotif.api.app.create_app">[docs]</a><span class="k">def</span> <span class="nf">create_app</span><span class="p">(</span><span class="n">DB_URI</span><span class="p">,</span> <span class="n">shacl_engine</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;pyshacl&quot;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Creates a Flask API.</span>
 
 <span class="sd">    :param db_uri: database URI</span>
 <span class="sd">    :type db_uri: str</span>
+<span class="sd">    :param shacl_engine: the name of the engine to use for validation: &quot;pyshacl&quot; or &quot;topquadrant&quot;. Using topquadrant</span>
+<span class="sd">        requires Java to be installed on this machine, and the &quot;topquadrant&quot; feature on BuildingMOTIF,</span>
+<span class="sd">        defaults to &quot;pyshacl&quot;</span>
+<span class="sd">    :type shacl_engine: str, optional</span>
 <span class="sd">    :return: flask app</span>
 <span class="sd">    :rtype: Flask.app</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">instance_relative_config</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
     <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">from_mapping</span><span class="p">(</span>
         <span class="n">DB_URI</span><span class="o">=</span><span class="n">DB_URI</span><span class="p">,</span>
     <span class="p">)</span>
-    <span class="n">app</span><span class="o">.</span><span class="n">building_motif</span> <span class="o">=</span> <span class="n">BuildingMOTIF</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;DB_URI&quot;</span><span class="p">])</span>
+    <span class="n">app</span><span class="o">.</span><span class="n">building_motif</span> <span class="o">=</span> <span class="n">BuildingMOTIF</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="p">[</span><span class="s2">&quot;DB_URI&quot;</span><span class="p">],</span> <span class="n">shacl_engine</span><span class="o">=</span><span class="n">shacl_engine</span><span class="p">)</span>
 
     <span class="n">app</span><span class="o">.</span><span class="n">after_request</span><span class="p">(</span><span class="n">_after_request</span><span class="p">)</span>
     <span class="n">app</span><span class="o">.</span><span class="n">register_error_handler</span><span class="p">(</span><span class="ne">Exception</span><span class="p">,</span> <span class="n">_after_error</span><span class="p">)</span>
 
     <span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">library_blueprint</span><span class="p">,</span> <span class="n">url_prefix</span><span class="o">=</span><span class="s2">&quot;/libraries&quot;</span><span class="p">)</span>
     <span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">template_blueprint</span><span class="p">,</span> <span class="n">url_prefix</span><span class="o">=</span><span class="s2">&quot;/templates&quot;</span><span class="p">)</span>
     <span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">model_blueprint</span><span class="p">,</span> <span class="n">url_prefix</span><span class="o">=</span><span class="s2">&quot;/models&quot;</span><span class="p">)</span>
+    <span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">parsers_blueprint</span><span class="p">,</span> <span class="n">url_prefix</span><span class="o">=</span><span class="s2">&quot;/parsers&quot;</span><span class="p">)</span>
 
     <span class="k">return</span> <span class="n">app</span></div>