Working in Rhino
The core library of COMPAS (compas), and the Rhino CAD package (compas_rhino)
are backwards compatible with Python 2.7 and written in pure Python,
such that they can be used in Rhino IronPython scripts (Rhino 7 and below),
as well as in the new Rhino CPython scripts (Rhino 8).
Installation
Warning
These instructions are for Rhino 6 and 7. For Rhino 8, please refer to Working in Rhino 8.
To use COMPAS in Rhino 6 or 7, you need to make Rhino aware of your COMPAS installation. This can be done with a simple command on the command line.
Note
Assuming COMPAS is installed in a conda environment, make sure to activate the environment before running any of the commands below.
It is recommended to also close Rhino before running the commands.
If Rhino was still running, it will have to restarted before the changes take effect.
python -m compas_rhino.install
This will install all Rhino-compatible packages of COMPAS that are present in the current Python environment into Rhino. It will also automatically install all GH Components that are available for the installed packages. Once the command terminates, you should see a message like this:
...
The default Rhino version is 8.
To install into Rhino 7, use the -v flag.
python -m compas_rhino.install -v 7.0
Note that if COMPAS is installed in a conda environment, you need to activate it the environment before running the command.
conda activate compas-dev
python -m compas_rhino.install
Verification
To test if the installation was successful, you can run the following script in Rhino.
import compas
print(compas.__version__)
Visualisation
Visualisation of COMPAS objects in Rhino is handled using viualisation scenes. For more information on visualisation scenes, see Visualisation.
import compas
from compas.datastructures import Mesh
from compas.scene import Scene
mesh = Mesh.from_obj(compas.get('tubemesh.obj'))
scene = Scene()
scene.clear()
scene.add(mesh)
scene.draw()