Deploy to GitHub pages

latest/api/compas_timber.ghpython.html

@@ -59,7 +59,7 @@
         </script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="JointDefinition" href="generated/compas_timber.ghpython.JointDefinition.html" />
+    <link rel="next" title="rhino" href="compas_timber.rhino.html" />
     <link rel="prev" title="SimpleSequenceGenerator" href="generated/compas_timber.planning.SimpleSequenceGenerator.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -592,24 +592,6 @@ <h1>compas_timber.ghpython</h1>
 <h2>Classes</h2>
 <table class="autosummary longtable table autosummary">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.JointDefinition.html" title="compas_timber.ghpython.JointDefinition"><code class="xref py py-obj docutils literal notranslate"><span class="pre">JointDefinition</span></code></a></p></td>
-<td><p>Container for a joint type and the beam that shall be joined.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.CategoryRule.html" title="compas_timber.ghpython.CategoryRule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CategoryRule</span></code></a></p></td>
-<td><p>Based on the category attribute attached to the beams, this rule assigns</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.TopologyRule.html" title="compas_timber.ghpython.TopologyRule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TopologyRule</span></code></a></p></td>
-<td><p>for a given connection topology type (L,T,X,I,K...), this rule assigns a joint type.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.DirectRule.html" title="compas_timber.ghpython.DirectRule"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DirectRule</span></code></a></p></td>
-<td><p>Creates a Joint Rule that directly joins two beams.</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.FeatureDefinition.html" title="compas_timber.ghpython.FeatureDefinition"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FeatureDefinition</span></code></a></p></td>
-<td><p>Container linking a feature for the beams on which it should be applied.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/compas_timber.ghpython.DebugInfomation.html" title="compas_timber.ghpython.DebugInfomation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DebugInfomation</span></code></a></p></td>
-<td><p>Container for debugging information allowing visual inspection of joint and features related errors.</p></td>
-</tr>
 </tbody>
 </table>
 </section>

latest/api/compas_timber.rhino.html

@@ -60,7 +60,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="find_neighboring_beams" href="generated/compas_timber.rhino.find_neighboring_beams.html" />
-    <link rel="prev" title="DebugInfomation.add_joint_error" href="generated/compas_timber.ghpython.DebugInfomation.add_joint_error.html" />
+    <link rel="prev" title="compas_timber.ghpython" href="compas_timber.ghpython.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>

latest/api/generated/compas_timber.connections.BeamJoinningError.html

@@ -593,7 +593,7 @@
 <h1>BeamJoinningError</h1>
 <dl class="py exception">
 <dt class="sig sig-object py" id="compas_timber.connections.BeamJoinningError">
-<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.connections.</span></span><span class="sig-name descname"><span class="pre">BeamJoinningError</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/joint.py#L10"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.connections.</span></span><span class="sig-name descname"><span class="pre">BeamJoinningError</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/joint.py#L10"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
 <p>Indicates that an error has occurred while trying to join two or more beams.</p>
 <p>This error should indicate that an error has occurred while calculating the features which

latest/api/generated/compas_timber.connections.ConnectionSolver.find_intersecting_pairs.html

@@ -598,7 +598,7 @@
 <h1>ConnectionSolver.find_intersecting_pairs</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.ConnectionSolver.find_intersecting_pairs">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ConnectionSolver.</span></span><span class="sig-name descname"><span class="pre">find_intersecting_pairs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">beams</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtree</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_distance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/solver.py#L90"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ConnectionSolver.</span></span><span class="sig-name descname"><span class="pre">find_intersecting_pairs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">beams</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtree</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_distance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/solver.py#L90"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Finds pairs of intersecting beams in the given list of beams.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>

latest/api/generated/compas_timber.connections.ConnectionSolver.find_topology.html

@@ -598,7 +598,7 @@
 <h1>ConnectionSolver.find_topology</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.ConnectionSolver.find_topology">
-<span class="sig-prename descclassname"><span class="pre">ConnectionSolver.</span></span><span class="sig-name descname"><span class="pre">find_topology</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">beam_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beam_b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_distance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/solver.py#L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">ConnectionSolver.</span></span><span class="sig-name descname"><span class="pre">find_topology</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">beam_a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">beam_b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_distance</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/solver.py#L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>If <cite>beam_a</cite> and <cite>beam_b</cite> intersect within the given <cite>max_distance</cite>, return the topology type of the intersection.</p>
 <p>If the topology is role-sensitive, the method outputs the beams in a consistent specific order
 (e.g. main beam first, cross beam second), otherwise, the beams are outputted in the same

latest/api/generated/compas_timber.connections.ConnectionSolver.html

@@ -593,7 +593,7 @@
 <h1>ConnectionSolver</h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="compas_timber.connections.ConnectionSolver">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.connections.</span></span><span class="sig-name descname"><span class="pre">ConnectionSolver</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/solver.py#L85"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_timber.connections.</span></span><span class="sig-name descname"><span class="pre">ConnectionSolver</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/solver.py#L85"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Provides tools for detecting beam intersections and joint topologies.</p>
 <p class="rubric">Methods</p>

latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.ToString.html

@@ -598,7 +598,7 @@
 <h1>FrenchRidgeLapJoint.ToString</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.FrenchRidgeLapJoint.ToString">
-<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">ToString</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/../../../../../../../opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/compas/data/data.py#L160"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">ToString</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/../../../../../../../opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/compas/data/data.py#L160"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Converts the instance to a string.</p>
 <p>This method exists for .NET compatibility. When using IronPython,
 the implicit string conversion that usually takes place in CPython

latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.add_features.html

@@ -598,7 +598,7 @@
 <h1>FrenchRidgeLapJoint.add_features</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.FrenchRidgeLapJoint.add_features">
-<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">add_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/joint.py#L69"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">add_features</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/joint.py#L69"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Adds the features defined by this joint to affected beam(s).</p>
 <dl class="field-list simple">
 <dt class="field-odd">Raises<span class="colon">:</span></dt>

latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.check_geometry.html

@@ -598,7 +598,7 @@
 <h1>FrenchRidgeLapJoint.check_geometry</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.FrenchRidgeLapJoint.check_geometry">
-<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">check_geometry</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/french_ridge_lap.py#L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">check_geometry</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/french_ridge_lap.py#L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>This method checks whether the parts are aligned as necessary to create French Ridge Lap and determines which face is used as reference face for machining.</p>
 </dd></dl>
 

latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.copy.html

@@ -598,7 +598,7 @@
 <h1>FrenchRidgeLapJoint.copy</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.FrenchRidgeLapJoint.copy">
-<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/../../../../../../../opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/compas/data/data.py#L269"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/../../../../../../../opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/compas/data/data.py#L269"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Make an independent copy of the data object.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>

latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.create.html

@@ -598,7 +598,7 @@
 <h1>FrenchRidgeLapJoint.create</h1>
 <dl class="py method">
 <dt class="sig sig-object py" id="compas_timber.connections.FrenchRidgeLapJoint.create">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">beams</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/6b66a71/src/compas_timber/connections/joint.py#L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">FrenchRidgeLapJoint.</span></span><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">beams</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_timber/blob/c583bc0/src/compas_timber/connections/joint.py#L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Creates an instance of this joint and creates the new connection in <cite>model</cite>.</p>
 <p><cite>beams</cite> are expected to have been added to <cite>model</cite> before calling this method.</p>
 <p>This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting