Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.48 KB

README.md

File metadata and controls

51 lines (34 loc) · 1.48 KB

Build Status

IronPython

ladybug-rhino

A library for communicating between Ladybug Tools core libraries and Rhinoceros CAD.

This library is used by both the Grasshopper and Rhino plugins to communicate with the ladybug core Python library. Note that this library has dependencies on Rhino SDK and Grasshopper SDK and is intended to contain all of such dependencies for the LBT-Grasshopper plugin. It is NOT intended to be run with cPython with the exceptions of running the CLI or when used with the cPython capabilities in Rhino 8.

Installation

pip install -U ladybug-rhino

To check if Ladybug Rhino command line is installed correctly try ladybug-rhino viz and you should get a viiiiiiiiiiiiizzzzzzzzz! back in response!

Local Development

  1. Clone this repo locally
git clone git@github.com:ladybug-tools/ladybug-rhino

# or

git clone https://github.com/ladybug-tools/ladybug-rhino
  1. Install dependencies
cd ladybug-rhino
pip install -r dev-requirements.txt
pip install -r requirements.txt
pip install pythonnet
pip install rhinoinside
  1. Generate Documentation
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_rhino
sphinx-build -b html ./docs ./docs/_build/docs