GITBOOK-37: working on Manual section

Author: juney-lee

gitbook/README.md

@@ -6,17 +6,21 @@ description: The official guide to using RhinoVAULT
 
 <figure><img src=".gitbook/assets/RV_splash.jpg" alt=""><figcaption></figcaption></figure>
 
+RhinoAULT is an interactive form-finding plug-in for Rhinoceros®s
+
+
+
 The Rhinoceros® plug-in [RhinoVAULT](https://www.food4rhino.com/en/app/rhinovault), originally developed by Dr. Matthias Rippmann at the Block Research Group at ETH Zurich, emerged from research on structural form finding using the _Thrust Network Analysis (TNA)_ approach to intuitively create and explore compression-only structures.
 
 Using reciprocal diagrams, RhinoVAULT provides an intuitive, fast funicular form-finding method, adopting the same advantages of techniques such as _Graphic Statics_, but offering a viable extension to three-dimensional problems. Our goal is to share a transparent setup to let you not only create beautiful shapes but also to give you an understanding of the underlying structural principles.
 
-The current version of RhinoVAULT is implemented based on the [COMPAS](https://compas-dev.github.io/) framework.&#x20;
+The current development of RhinoVAULT is implemented based on the [COMPAS](https://compas-dev.github.io/) framework.
 
 ***
 
 ## Research Platform <a href="#research-platform" id="research-platform"></a>
 
-‌RhinoVAULT is an open-source research and development platform for funicular form-finding built with [COMPAS](https://compas-dev.github.io/), a Python-based framework for computational research and collaboration in Architecture, Engineering, and Digital Fabrication.&#x20;
+‌RhinoVAULT is an open-source research and development platform for funicular form-finding built with [COMPAS](https://compas-dev.github.io/), a Python-based framework for computational research and collaboration in Architecture, Engineering, and Digital Fabrication.
 
 RhinoVAULT is a plugin that is specifically developed for Rhino 8 and above, built entirely with open source packages from the COMPAS ecosystem and will, therefore, be available not only for Rhino and Grasshopper, but also for Blender and other tools with a Python scripting interface, and ultimately even in the browser.
 

gitbook/manual/boundary-conditions.md

@@ -6,13 +6,7 @@ A `Pattern` object is a mesh datastructure that describes the topology of the st
 
 <table><thead><tr><th></th><th width="228"></th><th></th></tr></thead><tbody><tr><td> <img src="../.gitbook/assets/RV_supports (2).svg" alt=""></td><td><p><strong>Rhino command name</strong></p><p><code>RV_pattern_supports</code></p></td><td><p><strong>source file</strong></p><p><a href="../../plugin/RV_pattern_supports.py"><code>RV_pattern_supports.py</code></a></p></td></tr></tbody></table>
 
-In RhinoVAULT, a _support_ is defined as a vertex of the structure that is fixed, and can have external horizontal reactions. `RV_pattern_supports` allows user to _Add_ ore _Remove_ supports from the `Pattern`. The vertices can be selected using these modes:
-
-* **All**: all vertices
-* **Boundary**: all boundary vertices
-* **Degree**: selects vertices based on a defined _vertex degree_ (number of edges that are connected to that vertex)
-* **EdgeLoop**: selects all vertices along the edge loop of the selected edge
-* **Manual**: manually select vertices
+In RhinoVAULT, a _support_ is defined as a vertex of the structure that is fixed, and can have external horizontal reactions. `RV_pattern_supports` allows user to _Add_ ore _Remove_ supports from the `Pattern`.&#x20;
 
 ***
 

gitbook/manual/horizontal-equilibrium.md

@@ -4,9 +4,23 @@
 | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_horizontal-eq (1).svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_tna_horizontal</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_tna_horizontal.py"><code>RV_tna_horizontal.py</code></a></p> |
 
-## Alpha
+This function geometrically reconfigures the the edges of the ForceDiagram, such that the corresponding edges of the FormDiagram and Forcediagram become parallel (in the conventional graphic statics sense), or perpendicular (the 90° rotated, RhinoVAULT convention). The resulting ForceDiagram and FormDiagram are reciprocal where the two diagrams are topological duals of the other and all pairs of corresponding edges are parallel (within tolerance).
 
-In RV2, horizontal equilibrium is computed by parallelising the edges of the Form and Force Diagram to corresponding target vectors. These target vectors are defined as the weighted average of the vectors of corresponding edge pairs. Therefore, the most important parameter for the calculation of horizontal equilibrium in RV2 is `alpha`, which is the weighting factor for the calculation of the target vectors.
+***
+
+## Deviation Angles
+
+
+
+
+
+***
+
+## Sub functions
+
+### Alpha
+
+In RhinoVAULT, horizontal equilibrium is computed by parallelising the edges of the Form and Force Diagram to corresponding target vectors. These target vectors are defined as the weighted average of the vectors of corresponding edge pairs. Therefore, the most important parameter for the calculation of horizontal equilibrium in RV2 is `alpha`, which is the weighting factor for the calculation of the target vectors.
 
 If `alpha = 100`, the target vectors are completely defined by the vectors of the edges of the Form Diagram. This means that only the geometry of the Force Diagram will be updated to achieve horizontal equilibrium. This is the default.
 
@@ -22,7 +36,7 @@ Note that using `alpha` efficiently requires a bit of practice and experience. S
 
 ***
 
-## Iterations
+### Iterations
 
 Computing horizontal equilibrium is an iterative process. The default number of iterations is `100`. For sensible force layouts, this value should go a long way. However, there are many cases in which more iterations are required. For example, if the Form Diagram has multiple open/unsupported edges, and especially if those edges have a low "sag" value, more iterations will typically be required to reduce all angle deviations between corresponding edges to less than 5 degrees.
 
@@ -32,7 +46,7 @@ Furthermore, resolving all angle deviations is not an absolute requirement, and
 
 ***
 
-## Refreshrate
+### Refreshrate
 
 The iterations of the horizontal equilibrium calculation process is dynamically visualised. The rate at which the diagrams are updated is controlled by the refreshrate. The default value is `10`, which means that the diagrams are updated every 10 iterations.
 

gitbook/manual/patterns.md

@@ -64,12 +64,57 @@ This function automatically generates a mesh grid using number and size of the g
 
 Not implemented.
 
+
+
 ***
 
+
+
 ## 1b. Modify Pattern
 
 |                                                                                  |                                                                    |                                                                                                                |
 | -------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_pattern-modify.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p>RV_pattern_modify</p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_pattern_modify.py">RV_pattern_modify.py</a></p> |
 
-Not implemented.
+### VertexAttributes
+
+
+
+* **All**: all vertices
+* **Boundary**: all boundary vertices
+* **Degree**: selects vertices based on a defined _vertex degree_ (number of edges that are connected to that vertex)
+* **EdgeLoop**: selects all vertices along the edge loop of the selected edge
+* EdgeStrip: selects all vertices on the edge strip of a selected edge
+* **Manual**: manually select vertices
+
+
+
+
+
+* is\_fixed
+* is\_support
+* x
+* y
+* z
+
+### EdgeAttributes
+
+
+
+* **All**: all vertices
+* **Boundary**: all boundary vertices
+* **EdgeLoop**: selects all vertices along the edge loop of the selected edge
+* EdgeStrip: selects all vertices on the edge strip of a selected edge
+* **Manual**: manually select vertices
+
+
+
+
+
+
+
+
+
+* lmax
+* lmin
+* q

gitbook/theoretical-background/rhinovault.md

@@ -2,9 +2,9 @@
 
 <figure><img src="../.gitbook/assets/RV_splash-original.png" alt=""><figcaption></figcaption></figure>
 
-The Rhinoceros® plug-in RhinoVAULT, developed by Dr. Matthias Rippmann at the Block Research Group of ETH Zurich, emerged from research on structural form finding using Thrust Network Analysis (TNA) and was developed to facilitate the creation and exploration of compression-only, funicular structures.
+The Rhinoceros® plug-in RhinoVAULT was originally developed by Dr. Matthias Rippmann at the Block Research Group of ETH Zurich. It emerged from research on _Thrust Network Analysis_ (TNA) and was intended to facilitate the creation and exploration of compression-only, funicular structures.
 
-Based on TNA, RhinoVAULT provides an intuitive method for funicular form finding, adopting the same advantages of techniques such as graphic statics, but offering a viable extension to fully three-dimensional problems. The designer can control the many degrees of freedom of highly indeterminate three-dimensional equilibrium systems to explore structural form.
+Based on TNA, RhinoVAULT provides an intuitive method for funicular form finding, adopting advantages of techniques such as graphic statics, but offering a viable extension to fully three-dimensional problems. The designer can control the many degrees of freedom of highly indeterminate three-dimensional equilibrium systems to explore a variety of structural forms.
 
 Since its release in 2014, RhinoVAULT has been downloaded by more than 30.000 people, it was awarded in the category "Structure / Physics Formation" at ALGODeQ, an international competition for algorithmic design programs, and it has been used to design surprising free-form masonry vaults and shell structures all over the world.