Skip to content

Commit 33eeb38

Browse files
committed
more instructions
1 parent 5f70ae1 commit 33eeb38

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,18 @@ that can be used for form-finding tension-only, compression-only,
77
and mixed tension-compression structures,
88
using constrained force-density and constrained dynamric relaxation solvers.
99

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+
1017
## Installation
1118

1219
The plugin can be installed using Rhino's package manager Yak.
1320

14-
![COMPAS FormFinder installation with Yak](compas-FoFin_installation.png)
21+
![COMPAS FormFinder installation with Yak](compas-FoFin_yak.png)
1522

1623
## COMPAS Packages
1724

@@ -23,12 +30,22 @@ It uses the following packages of the COMPAS framework:
2330
* [compas_dr](https://github.com/blockresearchgroup/compas_dr)
2431

2532
Note that, at least for now, these packages have to be installed separately from the plugin itself.
26-
This can be done as described in the COMPAS docs (see ...),
33+
This can be done as described in the COMPAS docs (see [Working in Rhino 8](https://compas.dev/compas/latest/userguide/cad.rhino8.html)),
2734
or using the Python3 shell available in the Rhino ScriptEditor.
2835

36+
![COMPAS FormFinder packages](compas-FoFin_cpython-shell.png)
37+
38+
> [!WARNING]
39+
> We recommend using `pip` based install exclusively,
40+
> and not mix this installation mechanism with the `# r: package`
41+
> syntax available for CPython scripts in the new Rhino ScriptEditor,
42+
> since this can result in duplicated package installations with incompatible versions.
43+
2944
## Documentation
3045

31-
The functionality of the plugin is documented in this gitbook: <https://blockresearchgroup.gitbook.io/compas-fofin>
46+
The functionality of the plugin is documented in this gitbook: <https://blockresearchgroup.gitbook.io/compas-fofin>.
47+
48+
3249

3350
## Issues
3451

compas-FoFin_cpython-shell.png

1.7 MB
Loading

0 commit comments

Comments
 (0)