diff --git a/gitbook/.gitbook/assets/RV_early-application-examples.jpg b/gitbook/.gitbook/assets/RV_early-application-examples.jpg new file mode 100644 index 0000000..bb37ac7 Binary files /dev/null and b/gitbook/.gitbook/assets/RV_early-application-examples.jpg differ diff --git a/gitbook/.gitbook/assets/compas_cluster-diagram.png b/gitbook/.gitbook/assets/compas_cluster-diagram.png new file mode 100644 index 0000000..74418c0 Binary files /dev/null and b/gitbook/.gitbook/assets/compas_cluster-diagram.png differ diff --git a/gitbook/README.md b/gitbook/README.md index b4f06a0..3e3254a 100644 --- a/gitbook/README.md +++ b/gitbook/README.md @@ -1,11 +1,6 @@ --- description: The official guide to using RhinoVAULT -cover: .gitbook/assets/RV_splash.jpg -coverY: 0 layout: - cover: - visible: true - size: full title: visible: false description: @@ -20,39 +15,30 @@ layout: # About - -
+## Welcome to RhinoVAULT! + 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 development of RhinoVAULT is implemented based on the [COMPAS](https://compas-dev.github.io/) framework. +

Early examples of RhinoVAULT ca. 2010s.

*** -## Research Platform +### Research Platform -‌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. +‌The current version of 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. -*** - -## COMPAS +

The COMPAS ecosystem

-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`. +### Open Source -* [compas](https://github.com/compas-dev/compas) -* [compas\_ags](https://github.com/blockresearchgroup/compas\_fd) -* [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) - -*** +The development of RhinoVAULT is hosted on Github and is entirely open source, and we very much welcome your feedback. Please use the [issue tracker](https://github.com/BlockResearchGroup/compas-RV/issues) of the RhinoVAULT [GitHub repository](https://github.com/BlockResearchGroup/compas-RV) or the [COMPAS forum](https://forum.compas-framework.org/) to submit information about bugs, technical problems, or feature requests. -## Open Source +### Disclaimer -The development of RhinoVAULT is hosted on Github and is entirely open source, and we very much welcome your feedback. Please use the [issue tracker](https://github.com/BlockResearchGroup/compas-RV/issues) of the RhinoVAULT GitHub repository or the [COMPAS forum](https://forum.compas-framework.org/) to submit information about bugs, technical problems, or feature requests. +Although being developed and tested thoroughly, RhinoVAULT may contains errors – therefore no guarantee can be given that RhinoVAULT always computes correct results. Use of RhinoVAULT is entirely at your own risk, and please read the [legal terms](additional/legal.md) carefully before using RhinoVAULT. diff --git a/gitbook/introduction/getting-started.md b/gitbook/introduction/getting-started.md index f70b951..76f80ff 100644 --- a/gitbook/introduction/getting-started.md +++ b/gitbook/introduction/getting-started.md @@ -43,12 +43,18 @@ To check the installation, simply press the left-most button on the toolbar. Thi

RhinoVAULT splash screen

+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`. + +* [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) + {% 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. +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 %} *** -## Issue Tracker - -If you have any issues with the installation, please submit an issue or question on the RhinoVAULT [Issue Tracker](https://github.com/blockresearchgroup/compas-RV/issues). +##