Skip to content

Commit

Permalink
deploy: ad73278
Browse files Browse the repository at this point in the history
  • Loading branch information
gtfierro committed Nov 28, 2023
1 parent a3f6886 commit 03e25b8
Show file tree
Hide file tree
Showing 166 changed files with 8,260 additions and 7,039 deletions.
Binary file modified .doctrees/README.doctree
Binary file not shown.
Binary file modified .doctrees/bibliography.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/explanations/ingresses.doctree
Binary file not shown.
Binary file removed .doctrees/explanations/shapes-and-templates.doctree
Binary file not shown.
Binary file modified .doctrees/guides/csv-import.doctree
Binary file not shown.
Binary file modified .doctrees/guides/ingress-bacnet-to-brick.doctree
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/reference/apidoc/_autosummary/buildingmotif.api.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/reference/apidoc/_autosummary/buildingmotif.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/reference/apidoc/index.doctree
Binary file not shown.
Binary file modified .doctrees/reference/cli_tool.doctree
Binary file not shown.
Binary file modified .doctrees/reference/developer_documentation.doctree
Binary file not shown.
Binary file modified .doctrees/tutorials/model_correction.doctree
Binary file not shown.
Binary file modified .doctrees/tutorials/model_creation.doctree
Binary file not shown.
Binary file modified .doctrees/tutorials/model_validation.doctree
Binary file not shown.
Binary file modified .doctrees/tutorials/template_writing.doctree
Binary file not shown.
90 changes: 42 additions & 48 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
<!DOCTYPE html>


<html lang="en" >
<html >

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<title>BuildingMOTIF &#8212; BuildingMOTIF Documentation</title>

Expand All @@ -19,12 +19,12 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=365ca57ee442770a23c6" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=365ca57ee442770a23c6" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=365ca57ee442770a23c6" rel="stylesheet" />
<link href="_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />


<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=365ca57ee442770a23c6" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
Expand All @@ -38,14 +38,12 @@
<link rel="stylesheet" type="text/css" href="_static/design-style.4045f2051d55cab465a707391d5b2007.min.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=365ca57ee442770a23c6" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=365ca57ee442770a23c6" />
<script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=365ca57ee442770a23c6"></script>
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
Expand All @@ -68,7 +66,7 @@
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Developer Documentation" href="reference/developer_documentation.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:language" content="None"/>
</head>


Expand All @@ -78,15 +76,6 @@

<a class="skip-link" href="#main-content">Skip to main content</a>

<div id="pst-scroll-pixel-helper"></div>


<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
Back to top
</button>


<input type="checkbox"
class="sidebar-toggle"
name="__primary"
Expand Down Expand Up @@ -152,14 +141,13 @@









<img src="_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-light" alt="BuildingMOTIF Documentation - Home"/>
<script>document.write(`<img src="_static/BuildingMOTIF-logo-rev.svg" class="logo__image only-dark" alt="BuildingMOTIF Documentation - Home"/>`);</script>
<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>


</a></div>
Expand Down Expand Up @@ -208,11 +196,13 @@
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.bacnet.html">buildingmotif.ingresses.bacnet</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.base.html">buildingmotif.ingresses.base</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.brick.html">buildingmotif.ingresses.brick</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.csv.html">buildingmotif.ingresses.csv</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.csvingress.html">buildingmotif.ingresses.csvingress</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.naming_convention.html">buildingmotif.ingresses.naming_convention</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.template.html">buildingmotif.ingresses.template</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.ingresses.xlsx.html">buildingmotif.ingresses.xlsx</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.label_parsing.html">buildingmotif.label_parsing</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.libraries.html">buildingmotif.libraries</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.namespaces.html">buildingmotif.namespaces</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/apidoc/_autosummary/buildingmotif.schemas.html">buildingmotif.schemas</a></li>
Expand Down Expand Up @@ -243,7 +233,6 @@
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Explainations</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="explanations/ingresses.html">Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="explanations/shapes-and-templates.html">Shapes and Templates</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul class="nav bd-sidenav">
Expand Down Expand Up @@ -403,18 +392,18 @@

<script>
document.write(`
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>

<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
Expand Down Expand Up @@ -463,7 +452,7 @@ <h2> Contents </h2>
<article class="bd-article" role="main">

<section class="tex2jax_ignore mathjax_ignore" id="buildingmotif">
<h1>BuildingMOTIF<a class="headerlink" href="#buildingmotif" title="Permalink to this heading">#</a></h1>
<h1>BuildingMOTIF<a class="headerlink" href="#buildingmotif" title="Permalink to this headline">#</a></h1>
<p><a class="reference external" href="https://codecov.io/gh/NREL/BuildingMOTIF"><img alt="codecov" src="https://codecov.io/gh/NREL/BuildingMOTIF/branch/main/graph/badge.svg?token=HAFSYH45NX" /></a>
<a class="reference external" href="https://buildingmotif.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/buildingmotif/badge/?version=latest" /></a>
<img alt="PyPI" src="https://img.shields.io/pypi/v/buildingmotif" />
Expand All @@ -477,18 +466,18 @@ <h1>BuildingMOTIF<a class="headerlink" href="#buildingmotif" title="Permalink to
<p>Currently, <em><strong>BuildingMOTIF</strong></em> is planned to support <a class="reference external" href="https://brickschema.org/">Brick</a> Schema, <a class="reference external" href="https://project-haystack.org/">Project Haystack</a>, and the upcoming <a class="reference external" href="https://www.ashrae.org/about/news/2018/ashrae-s-bacnet-committee-project-haystack-and-brick-schema-collaborating-to-provide-unified-data-semantic-modeling-solution">ASHRAE 223P</a> standard, and to offer both UI and underlying SDK with tutorials and reference documentation to be useful for different levels of expertise of users for maximum adoption.</p>
</section>
<section class="tex2jax_ignore mathjax_ignore" id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">#</a></h1>
<p>The documentation uses Diataxis<a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> as a framework for its structure, which is organized into the following sections.</p>
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">#</a></h1>
<p>The documentation uses Diataxis<a class="footnote-reference brackets" href="#id2" id="id1">1</a> as a framework for its structure, which is organized into the following sections.</p>
<section id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this heading">#</a></h2>
<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">#</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>
<section id="tutorials">
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this heading">#</a></h2>
<h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline">#</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/tutorials/model_creation.html">Model Creation</a></p></li>
<li><p><a class="reference external" href="https://nrel.github.io/BuildingMOTIF/tutorials/model_validation.html">Model Validation</a></p></li>
Expand All @@ -497,28 +486,29 @@ <h2>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this he
</ul>
</section>
<section id="guides">
<h2>Guides<a class="headerlink" href="#guides" title="Permalink to this heading">#</a></h2>
<h2>Guides<a class="headerlink" href="#guides" title="Permalink to this headline">#</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="explanations">
<h2>Explanations<a class="headerlink" href="#explanations" title="Permalink to this heading">#</a></h2>
<h2>Explanations<a class="headerlink" href="#explanations" title="Permalink to this headline">#</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>
<h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this headline">#</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>
<p><a class="reference external" href="https://diataxis.fr/">https://diataxis.fr/</a></p>
</aside>
<dl class="footnote brackets">
<dt class="label" id="id2"><span class="brackets"><a class="fn-backref" href="#id1">1</a></span></dt>
<dd><p><a class="reference external" href="https://diataxis.fr/">https://diataxis.fr/</a></p>
</dd>
</dl>
</section>
<div class="toctree-wrapper compound">
</div>
Expand Down Expand Up @@ -557,10 +547,11 @@ <h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this head





<footer class="prev-next-footer">
<!-- Previous / next buttons -->
<footer class="bd-footer-article">

<div class="footer-article-items footer-article__inner">

<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="right-next"
href="reference/developer_documentation.html"
Expand All @@ -571,7 +562,10 @@ <h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this head
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div></div>

</div>

</footer>

</div>
Expand Down Expand Up @@ -643,8 +637,8 @@ <h2>Appendix<a class="headerlink" href="#appendix" title="Permalink to this head
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=365ca57ee442770a23c6"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=365ca57ee442770a23c6"></script>
<script src="_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>

<footer class="bd-footer">
</footer>
Expand Down
Loading

0 comments on commit 03e25b8

Please sign in to comment.