Skip to content

Commit 052000f

Browse files
committed
instructions
1 parent a260617 commit 052000f

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

README.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
11
# COMPAS Formfinder for Rhino
22

3+
> [!NOTE]
4+
> The current version of COMPAS-FormFinder on the Yak package server is `0.2.5`.
5+
> Note that this is still a pre-release!
6+
37
![COMPAS FormFinder](compas-FoFin.png)
48

59
COMPAS Formfinder for Rhino is a plugin for Rhino 8
610
that can be used for form-finding tension-only, compression-only,
711
and mixed tension-compression structures,
812
using constrained force-density and constrained dynamric relaxation solvers.
913

10-
> [!WARNING]
11-
> This plugin is under active development,
12-
> and uses the still somewhat unstable CPython infrastructure
13-
> of Rhino 8 through the new ScriptEditor.
14-
> Therefore, unexpected errors may occur here and there.
15-
> Please let us know via the [Issue Tracker](https://github.com/BlockResearchGroup/compas-FoFin/issues) if you have problems.
16-
1714
## Installation
1815

1916
To install FormFinder, use Rhino's package manager Yak.
@@ -30,20 +27,9 @@ FormFinder uses the following COMPAS packages:
3027
* [compas_rui](https://github.com/blockresearchgroup/compas_rui)
3128
* [compas_session](https://github.com/blockresearchgroup/compas_session)
3229

33-
After installing FormFinder with Yak, you can check if all requirements are installed using the command `RV_reqs_check`.
34-
35-
### Basic Users
36-
37-
Missing requirements can be installed automatically using the command `RV_reqs_install`.
38-
This command uses Rhino's built in installation mechanism for Python packages (`# r: ...`).
39-
40-
### Advanced Users
41-
42-
If you use Rhino for scripting, and if you have other COMPAS packages installed, or plan to install them in the future, we recommend to install FormFinder's requirements manually using `pip`.
43-
44-
> [!WARNING]
45-
> `pip` based installations and `# r: ...` based installations should not be mixed,
46-
> since this will create conflicts between packages and package versions.
30+
After installing RhinoVAULT with Yak, these requirements will be installed automatically if they are not yet available.
31+
Note that the tool ,ight be unresponsive for a few seconds while this happens.
32+
The packages are installed in a separate virtual environment named `rhinovault`.
4733

4834
## User Interface
4935

@@ -67,8 +53,6 @@ COMPAS FormFinder defines the following Rhino commands:
6753
* `FF_scene_clear`
6854
* `FF_scene_redraw`
6955
* `FF_settings`
70-
* `FF_reqs_check`
71-
* `FF_reqs_install`
7256

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

0 commit comments

Comments
 (0)