Skip to content

Developer Guide

Jump to bottom
Juney Lee edited this page Nov 6, 2024 · 17 revisions

This guide contains instructions to help you get started with the development of COMPAS RhinoVAULT.

Requirements

1. Clone COMPAS RhinoVAULT Repository

Clone the repository of COMPAS RhinoVAULT using Git or a Git GUI.

git clone https://github.com/BlockResearchGroup/compas-RV.git

The repo contains the following directories

  • data -- sample data for testing.
  • gitbook -- source code for the documentation gitbook.
  • plugin -- command scripts and project definition
  • resources -- general package resources such as illustrator files
  • src -- source code of compas_rv

Note

Note that the functionalities of compas_rv is not meaningful outside the context of this plugin in Rhino 8. It is therefore not released on PyPI, and it is not listed as one of the requirements in requirements.txt. It is included as a plugin "Library" and can be used in all command scripts without explicit installation.

2. Dev environment

Create a development environment, and install all "dev" requirements.

conda create -n rv-dev python=3.9 -y
conda activate rv-dev
cd compas-RV
python -m pip install -e ".[dev]"

Warning

This environment is independent of Rhino. It does not replace the steps described in the next section. it is useful for working in parallel with VS Code, and for making "editable installs" as described later.

Clone this wiki locally