From cfa0284f07b120ea407868576c3355d7856f3315 Mon Sep 17 00:00:00 2001
From: Juney Lee <juney@cmu.edu>
Date: Sun, 10 Nov 2024 22:24:45 +0000
Subject: [PATCH] GITBOOK-43: settings descriptions

---
 gitbook/manual/settings.md | 32 ++++++++++++--------------------
 1 file changed, 12 insertions(+), 20 deletions(-)

diff --git a/gitbook/manual/settings.md b/gitbook/manual/settings.md
index 7d63a30..eef6a9e 100644
--- a/gitbook/manual/settings.md
+++ b/gitbook/manual/settings.md
@@ -6,37 +6,29 @@
 | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_settings (1).svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_settings</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_settings.py"><code>RV_settings.py</code></a></p> |
 
-Description
-
-
-
-
+Under `Settings`, global parameters (`RhinoVAULT`, `ThrustNetworkAnalysis`) and visualization (`Drawing`) options can be modified. For each of the categories, various parameters and display settings can be modified. The modifiable parameters for each category are summarized below.
 
 ***
 
-## Options
+## Settings categories
 
 ### RhinoVAULT
 
+These are the global parameters for RhinoVAULT.
 
-
-* autosave on by default
-* autoupdate off by default
-
-
+* **`autosave`** - If set to `True`, session files are saved every time a change has been made in the scene. Set to `True` by default.
+* **`autoupdate`**  - If set to `True`, any modifications made in the scene will automatically update the `ThrustDiagram`. Set to `False` by default.
 
 ### ThrustNetworkAnalysis
 
+These are the parameters related to [Horizontal equilibrium](horizontal-equilibrium.md) and [Vertical equilibrium](fitting.md) solvers.
 
-
-* horizontal\_kmax
-* horizontal\_alpha
-* horizontal\_max\_angle
-* horizontal\_refreshrate
-* vertical\_kmax
-* vertical\_zmax
-
-
+* **`horizontal_kmax`** - Number of iterations to be executed by `RV_tna_horizontal` (horizontal equilibrium solver). This number can be reset before the solver is run. This number is set to 100 by default.
+* **`horizontal_alpha`** - Percentage value (0.0 to 100.0) that determines how much influence `FormDiagram` has during `RV_tna_horizontal`. For example, an `Alpha` value of 100.0 means that the `FormDiagram` remains fixed and only the `ForceDiagram` will be reconfigures, while an Alpha value of 50 will reconfigure both the `FormDiagram` and `ForceDiagram` with equal weight. This value is set to 100.0 by default.
+* **`horizontal_max_angle`** - Tolerance value for displaying angle deviations. If the maximum angle deviation between a pair of corresponding edges in the `FormDiagram` and the `ForceDiagram` is greater than this value, angle deviation will be displayed in the scene with a Rhino dot. This value is set to 5.0 by default.
+* **`horizontal_refreshrate`** - Number of iterations to skip during dynamic visualization of `RV_tna_horizontal`. For example, a value of 1 will visualize every iteration step, and therefore take much longer for the final result to be displayed. This value is set to 5 by default.
+* **`vertical_kmax`** - Number of iterations to be executed by `RV_tna_vertical` (vertical equilibrium solver).  This number is set to 300 by default.
+* **`vertical_zmax`** - Default target height for the `ThrustDiagram`. This value is automatically computed and set by the dimensions of the bounding box of the `FormDiagram` in the scene.
 
 ### Drawing