Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 3.04 KB

INSTALL.md

File metadata and controls

62 lines (41 loc) · 3.04 KB

To use this tool (we avoid the term plugin, as it isn't a proper plugin), you need to follow those two steps. This solution is not very elegant but is adapted to the time available for this project 🏃‍♀️‍➡️.

2-step install:

  1. Add the src folder with the codes to the "scripts" folder of Rhino. (At every new release, the old files must be deleted). Please note that the Library (MacOS) and AppData (Windows) folders are "hidden folders". On MacOS press command+shift+. to reveal the hidden folders. On Windows 10 or 11, see this link

MacOS path:

/Users/<your_username>/Library/Application support/McNeel/Rhinoceros/8.0/scripts

NB: For unexplicable reasons, in the GUI, Apple changes the naming of "Library" in function of the system language, but not on the terminal. For example if our OS is in French and you want to find the folder using the "Finder", replace "Library" with "Bibliothèque"...

Windows path:

C:\Users\<your_username>\AppData\Roaming\McNeel\Rhinoceros\8.0\scripts

Note that the "script" folder in the "8.0" folder might be missing, in which case you have to create it, respecting the exact spelling.

  1. In Rhino, drag-and-drop the .rhc container file ( Download link ). This file contains the metadata that creates the "Carnutes" toolbar tab with all the buttons calling the different scripts.

This solution is inelegant but corresponds to the developement time allocated to this project. If you know a better way, create an issue and tell me how to improve it 😇. The main issues are that a proper version tracking is inexistant, and installation is not super user friendly.

Dependencies

There is no need to install dependencies as they are all installed automatically using the # r: <package>

The dependencies are nevertheless listed here:

Change the database and add your own dataset

To create your own database with another dataset, you can activate the conda environment (assuming you have Conda installed on your computer), by running the following commands from the Carnutes root directory:

conda env create -f environment.yml
conda activate Carnutes

Navigate to the src directory:

cd src

And run the python script with:

MacOS:

/Users/<your_username>/anaconda3/envs/database_creation/bin/python database_creator.py

Windows:

C:\Users\<your_username>\anaconda3\envs\database_creation\python.exe .\database_creator.py