Installation¤

Install the released Python package with pip, or clone both repositories when working on the bundled TypeScript viewer.

Stable Release¤

For the latest stable release, you can install compas_threejs directly from the command line with pip:

pip install compas_threejs

Using a virtual environment is recommended.

Clone and install the Python package in editable mode:

git clone https://github.com/compas-dev/compas_threejs.git
cd compas_threejs
pip install -e ".[dev]"

The TypeScript viewer lives in a separate repository. Clone it next to the Python repository:

cd ..
git clone https://github.com/compas-dev/compas_threejs_ts.git
cd compas_threejs_ts
npm ci
npm run dev

To rebuild the viewer and copy it into the Python package, run this from the Python repository:

cd ../compas_threejs
invoke sync-frontend