Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@chriswmackey
chriswmackey committed Oct 16, 2024
0 parents commit b37bab3
Show file tree
Hide file tree
Showing 110 changed files with 27,060 additions and 0 deletions.
1 change: 1 addition & 0 deletions .nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
4 changes: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: 31e511f1ae3350430be38be86adcb393
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/main.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_display.cli.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_display.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_display.model.doctree
Binary file not shown.
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/modules.doctree
Binary file not shown.
Empty file added docs/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
503 changes: 503 additions & 0 deletions docs/_modules/dragonfly_display/cli.html

Large diffs are not rendered by default.

258 changes: 258 additions & 0 deletions docs/_modules/dragonfly_display/model.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dragonfly_display.model &#8212; dragonfly display documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css?v=0bf093e7" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=0b9525ea" />
<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="icon" type="image/x-icon" href="https://github.com/ladybug-tools/artwork/raw/refs/heads/master/icons_bugs/ico/dragonfly.ico">
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="../../_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="../../_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="../../_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="../../_static/bootstrap-sphinx.js "></script>

</head><body>

<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
dragonfly display</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">


<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="../../index.html">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="../../cli/index.html">CLI Docs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../cli/index.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../cli/index.html#commands">Commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../cli/main.html">main</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../cli/main.html#dragonfly-display">dragonfly-display</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../cli/main.html#dragonfly-display-model-to-vis">model-to-vis</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">dragonfly_display</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../dragonfly_display.html">dragonfly_display package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../dragonfly_display.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../dragonfly_display.cli.html">dragonfly_display.cli package</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../dragonfly_display.cli.html#module-dragonfly_display.cli">Module contents</a><ul>
<li class="toctree-l6"><a class="reference internal" href="../../dragonfly_display.cli.html#dragonfly_display.cli.model_to_vis_set"><code class="docutils literal notranslate"><span class="pre">model_to_vis_set()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../dragonfly_display.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../dragonfly_display.model.html">dragonfly_display.model module</a><ul>
<li class="toctree-l5"><a class="reference internal" href="../../dragonfly_display.model.html#dragonfly_display.model.model_to_vis_set"><code class="docutils literal notranslate"><span class="pre">model_to_vis_set()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../dragonfly_display.html#module-dragonfly_display">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</ul>
</li>

<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="../../cli/index.html">CLI Docs</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">dragonfly_display</a></li>
</ul>
</ul>
</li>










<li class="hidden-sm"></li>

</ul>



<form class="navbar-form navbar-right" action="../../search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>

</div>
</div>
</div>

<div class="container">
<div class="row">
<div class="col-md-4">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li class="toctree-l1"><a class="reference internal" href="../../cli/index.html">CLI Docs</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../modules.html">dragonfly_display</a></li>
</ul>

</div>
</div>
<div class="body col-md-8 content" role="main">

<h1>Source code for dragonfly_display.model</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Method to translate a Dragonfly Model to a VisualizationSet.&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">honeybee_display.model</span> <span class="kn">import</span> <span class="n">model_to_vis_set</span> <span class="k">as</span> <span class="n">hb_model_to_vis_set</span>


<div class="viewcode-block" id="model_to_vis_set">
<a class="viewcode-back" href="../../dragonfly_display.model.html#dragonfly_display.model.model_to_vis_set">[docs]</a>
<span class="k">def</span> <span class="nf">model_to_vis_set</span><span class="p">(</span>
<span class="n">model</span><span class="p">,</span> <span class="n">use_multiplier</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">solve_ceiling_adjacencies</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">color_by</span><span class="o">=</span><span class="s1">&#39;type&#39;</span><span class="p">,</span> <span class="n">include_wireframe</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">use_mesh</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">hide_color_by</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">room_attrs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">face_attrs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">grid_display_mode</span><span class="o">=</span><span class="s1">&#39;Default&#39;</span><span class="p">,</span> <span class="n">hide_grid</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Translate a Dragonfly Model to a VisualizationSet.</span>

<span class="sd"> Args:</span>
<span class="sd"> model: A Dragonfly Model object to be converted to a VisualizationSet.</span>
<span class="sd"> use_multiplier: If True, the multipliers on this Model&#39;s Stories will be</span>
<span class="sd"> passed along to the generated Honeybee Room objects, indicating the</span>
<span class="sd"> simulation will be run once for each unique room and then results</span>
<span class="sd"> will be multiplied. If False, full geometry objects will be written</span>
<span class="sd"> for each and every floor in the building that are represented through</span>
<span class="sd"> multipliers and all resulting multipliers will be 1. (Default: True).</span>
<span class="sd"> solve_ceiling_adjacencies: Boolean to note whether adjacencies should be</span>
<span class="sd"> solved between interior stories when Room2D floor and ceiling</span>
<span class="sd"> geometries are coplanar. This ensures that Surface boundary</span>
<span class="sd"> conditions are used instead of Adiabatic ones. Note that this input</span>
<span class="sd"> has no effect when the object_per_model is Story. (Default: False).</span>
<span class="sd"> color_by: Text that dictates the colors of the Model geometry.</span>
<span class="sd"> If none, only a wireframe of the Model will be generated, assuming</span>
<span class="sd"> include_wireframe is True. This is useful when the primary purpose of</span>
<span class="sd"> the visualization is to display results in relation to the Model</span>
<span class="sd"> geometry or display some room_attrs or face_attrs as an AnalysisGeometry</span>
<span class="sd"> or Text labels. (Default: type). Choose from the following:</span>

<span class="sd"> * type</span>
<span class="sd"> * boundary_condition</span>
<span class="sd"> * None</span>

<span class="sd"> include_wireframe: Boolean to note whether a ContextGeometry dedicated to</span>
<span class="sd"> the Model Wireframe (in DisplayLineSegment3D) should be included</span>
<span class="sd"> in the output VisualizationSet. (Default: True).</span>
<span class="sd"> use_mesh: Boolean to note whether the colored model geometries should</span>
<span class="sd"> be represented with DisplayMesh3D objects (True) instead of DisplayFace3D</span>
<span class="sd"> objects (False). Meshes can usually be rendered faster and they scale</span>
<span class="sd"> well for large models but all geometry is triangulated (meaning that</span>
<span class="sd"> the wireframe in certain platforms might not appear ideal). (Default: True).</span>
<span class="sd"> hide_color_by: Boolean to note whether the color_by geometry should be</span>
<span class="sd"> hidden or shown by default. Hiding the color-by geometry is useful</span>
<span class="sd"> when the primary purpose of the visualization is to display grid_data</span>
<span class="sd"> or room/face attributes but it is still desirable to have the option</span>
<span class="sd"> to turn on the geometry.</span>
<span class="sd"> room_attrs: An optional list of room attribute objects from the</span>
<span class="sd"> honeybee_display.attr module.</span>
<span class="sd"> face_attrs: An optional list of face attribute objects from the</span>
<span class="sd"> honeybee_display.attr module.</span>
<span class="sd"> grid_display_mode: Text that dictates how the ContextGeometry for Model</span>
<span class="sd"> SensorGrids should display in the resulting visualization. The Default</span>
<span class="sd"> option will draw sensor points. Choose from the following:</span>

<span class="sd"> * Default</span>
<span class="sd"> * Points</span>
<span class="sd"> * Wireframe</span>
<span class="sd"> * Surface</span>
<span class="sd"> * SurfaceWithEdges</span>
<span class="sd"> * None</span>

<span class="sd"> hide_grid: Boolean to note whether the SensorGrid ContextGeometry should be</span>
<span class="sd"> hidden or shown by default. (Default: False).</span>

<span class="sd"> Returns:</span>
<span class="sd"> A VisualizationSet object that represents the model.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># create the Honeybee Model from the Dragonfly one</span>
<span class="n">hb_model</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">to_honeybee</span><span class="p">(</span>
<span class="s1">&#39;District&#39;</span><span class="p">,</span> <span class="n">use_multiplier</span><span class="o">=</span><span class="n">use_multiplier</span><span class="p">,</span>
<span class="n">solve_ceiling_adjacencies</span><span class="o">=</span><span class="n">solve_ceiling_adjacencies</span><span class="p">,</span>
<span class="n">enforce_adj</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">enforce_solid</span><span class="o">=</span><span class="kc">True</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># convert the Honeybee Model to a VisualizationSet</span>
<span class="k">return</span> <span class="n">hb_model_to_vis_set</span><span class="p">(</span>
<span class="n">hb_model</span><span class="p">,</span> <span class="n">color_by</span><span class="p">,</span> <span class="n">include_wireframe</span><span class="p">,</span> <span class="n">use_mesh</span><span class="p">,</span> <span class="n">hide_color_by</span><span class="p">,</span>
<span class="n">room_attrs</span><span class="p">,</span> <span class="n">face_attrs</span><span class="p">,</span> <span class="n">grid_display_mode</span><span class="p">,</span> <span class="n">hide_grid</span><span class="p">)</span></div>

</pre></div>

</div>

</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>

</p>
<p>
&copy; Copyright 2024, Ladybug Tools.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.0.2.<br/>
</p>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit b37bab3

Please sign in to comment.