-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GITBOOK-71: tidying up getting started
- Loading branch information
1 parent
2150256
commit b41b3a4
Showing
1 changed file
with
24 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,61 @@ | ||
| # Getting Started | ||
|
|
||
| COMPAS RhinoVAULT is a plugin for Rhino 8 and uses the new CPython runtime. It can be installed using Yak, Rhino's package manager. | ||
|
|
||
| {% hint style="warning" %} | ||
| COMPAS Masonry is **only available for Rhino 8.** | ||
| {% endhint %} | ||
| RhinoVAULT is a plugin for Rhino 8 and uses the new CPython runtime. It can be installed using Yak, Rhino's package manager. This page will guide you through the installation process for RhinoVAULT. | ||
|
|
||
| *** | ||
|
|
||
| ## Requirements | ||
|
|
||
| The following are the prerequisites for installing RhinoVAULT. | ||
|
|
||
| * [Rhino 8](https://www.rhino3d.com/) | ||
| * Windows 10 or above / macOS 12 or above | ||
|
|
||
| In case you do not possess [Rhino](https://www.rhino3d.com/), download a fully featured, free trial version. | ||
|
|
||
| {% hint style="warning" %} | ||
| RhinoVAULTLT is available for Rhino 8 **only.** | ||
| {% endhint %} | ||
|
|
||
| *** | ||
|
|
||
| ## Installation | ||
| ## 1. Installation | ||
|
|
||
| * Start Rhino 8 and launch Yak by typing `PackageManager` on the Rhino command line. | ||
| * Search the online packages for "RhinoVAULT". | ||
| * Select "COMPAS RhinoVAULT" from the list. | ||
| * Install. | ||
| 1. Start Rhino 8 and launch Yak by typing `PackageManager` in the Rhino command line. | ||
| 2. Search the online packages for "RhinoVAULT". | ||
| 3. Select "COMPAS RhinoVAULT" from the list. | ||
| 4. Make sure the latest version is selected, then click Install. | ||
|
|
||
| <figure><img src="../.gitbook/assets/RV_package-manager.png" alt=""><figcaption><p>Rhino package manager</p></figcaption></figure> | ||
|
|
||
| *** | ||
|
|
||
| ## 2. RhinoVAULT Toolbar | ||
|
|
||
| After the installation, you should see the RhinoVAULT toolbar in the Rhino workspace.  | ||
|
|
||
| <figure><img src="../.gitbook/assets/RV_toolbar (1).png" alt=""><figcaption><p>RhinoVAULT toolbar</p></figcaption></figure> | ||
|
|
||
| If the toolbar is not visible after installing RhinoVAULT, you can load it from the "Toolbars" page. To open the "Toolbars" page, type `Toolbars` on the Rhino command line. | ||
| If the toolbar is not visible after installing RhinoVAULT, you can load it from the "Toolbars" tab in Rhino options. To open the "Toolbars" page, type `Toolbars` on the Rhino command line. | ||
|
|
||
| <figure><img src="../.gitbook/assets/RV_toolbar-install.png" alt=""><figcaption><p>Load the toolbar using the "Toolbars" page.</p></figcaption></figure> | ||
| <figure><img src="../.gitbook/assets/RV_toolbar-install.png" alt=""><figcaption><p>Load the toolbar using the "Toolbars" tab in Rhino options.</p></figcaption></figure> | ||
|
|
||
| *** | ||
|
|
||
| ## Check the Installation | ||
|
|
||
| To check the installation, simply press the left-most button on the toolbar, or run the `RV` in the Rhino command prompt. This will install any missing COMPAS packages and display a "Splash" screen when the installation is completed. Close the screen by agreeing to the [legal terms](../additional-information/legal-terms.md) of using COMPAS-RhinoVAULT. | ||
| ## 3. Check the Installation | ||
|
|
||
| <figure><img src="../.gitbook/assets/RV_splash-window.png" alt=""><figcaption><p>RhinoVAULT splash screen</p></figcaption></figure> | ||
| To check the installation, simply press the left-most button on the toolbar, or run the command `RV` in the Rhino command prompt. A splash screen will pop up, where you will need to read and agree to the [legal terms](../additional-information/legal-terms.md) of using RhinoVAULT. | ||
|
|
||
| RhinoVAULT uses the following COMPAS packages. 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 `rhinovault`. | ||
| RhinoVAULT uses the following COMPAS packages, which will be installed automatically when `RV` command is triggered, if they are not yet available. The packages are installed in a separate virtual environment named `rhinovault`. | ||
|
|
||
| * [compas](https://github.com/compas-dev/compas) | ||
| * [compas\_fd](https://github.com/blockresearchgroup/compas\_fd) | ||
| * [compas\_rui](https://github.com/blockresearchgroup/compas\_rui) | ||
| * [compas\_session](https://github.com/blockresearchgroup/compas\_session) | ||
| * [compas\_tna](https://github.com/blockresearchgroup/compas\_dr) | ||
|
|
||
| <figure><img src="../.gitbook/assets/RV_splash-window.png" alt=""><figcaption><p>RhinoVAULT splash screen</p></figcaption></figure> | ||
|
|
||
| {% hint style="info" %} | ||
| Note that installing the packages (and the dependencies of the packages) may take some time, so don't worry if the the dialog doesn't pop up immediately. Be patient! | ||
| {% endhint %} | ||
|
|
||
| *** | ||
|
|
||
| ## |