Skip to content

Commit

Permalink
[GITBOOK] no duplicates
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvanmele committed Oct 3, 2024
1 parent d422e33 commit 51113b9
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 2 deletions.
File renamed without changes
48 changes: 46 additions & 2 deletions gitbook/introduction/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,59 @@ COMPAS FormFinder is **only available for Rhino 8.**

## Installation

* Start Rhino 8 and launch Yak from the "Tools" menu: ``Tools > Package Manager``.
* Start Rhino 8 and launch Yak by typing `PackageManager` on the Rhino command line.
* Search the online packages for "FormFinder".
* Select "COMPAS FormFinder" from the list.
* Install.

<figure><img src="../.gitbook/assets/FormFinder_yak.png" alt="FormFinder in package manager Yak"><figcaption><p>COMPAS FormFinder can be installed using Yak, the package manager of Rhino.</p></figcaption></figure>
<figure><img src="/gitbook/.gitbook/assets/FormFinder_yak.png" alt="FormFinder in package manager Yak"><figcaption><p>COMPAS FormFinder can be installed using Yak, the package manager of Rhino.</p></figcaption></figure>

## COMPAS Packages

FormFinder uses the following COMPAS packages:

* [compas](https://github.com/compas-dev/compas)
* [compas_dr](https://github.com/blockresearchgroup/compas_dr)
* [compas_fd](https://github.com/blockresearchgroup/compas_fd)
* [compas_rui](https://github.com/blockresearchgroup/compas_rui)
* [compas_session](https://github.com/blockresearchgroup/compas_session)

After installing RhinoVAULT with Yak, these requirements will be installed automatically if they are not yet available.
Note that the tool ,ight be unresponsive for a few seconds while this happens.
The packages are installed in a separate virtual environment named `formfinder`.

## Toolbar

COMPAS FormFinder defines the following Rhino commands:

* `FF`
* `FF_pattern`
* `FF_anchors`
* `FF_anchors_constraints`
* `FF_anchors_update`
* `FF_anchors_move`
* `FF_solve_fd`
* `FF_edges_q`
* `FF_edges_delete`
* `FF_vertices_attrs`
* `FF_edges_attrs`
* `FF_session_undo`
* `FF_session_redo`
* `FF_session_open`
* `FF_session_save`
* `FF_scene_clear`
* `FF_scene_redraw`
* `FF_settings`

These commands can be executed at the Rhino Command Prompt (simply start typing the command name),
or using the FormFinder toolbar.

<figure><img src="/gitbook/.gitbook/assets/FormFinder_toolbar.png" alt="COMPAS FormFinder toolbar"><figcaption><p>COMPAS FormFinder commands are available via the toolbar.</p></figcaption></figure>

If the toolbar is not visible after installing FormFinder,
you can load it from the "Toolbars" page.
To open the "Toolbars" page, type `Toolbars` on the Rhino command line...

<figure><img src="/gitbook/.gitbook/assets/Rhino_toolbars.png" alt="Rhino Toolbars page"><figcaption><p>Load the toolbar using the "Toolbars" page.</p></figcaption></figure>

## Check the Installation
Binary file removed resources/images/FormFinder_toolbar.png
Binary file not shown.
Binary file removed resources/images/FormFinder_yak.png
Binary file not shown.

0 comments on commit 51113b9

Please sign in to comment.