Welcome to Honeybee’s documentation!¶
Honeybee is a collection of Python libraries to create representations of buildings following honeybee-schema.
This package is the core library that provides honeybee’s common functionalities. To extend these functionalities you should install available Honeybee extensions or write your own.
Installation¶
To install the core library try pip install -U honeybee-core.
To check if the Honeybee command line interface is installed correctly try honeybee viz and you
should get a viiiiiiiiiiiiizzzzzzzzz! back in response!
Documentation¶
This document includes Honeybee API documentation and
Honeybee Command Line Interface documentation for honeybee core and does
not include the documentation for honeybee extensions. For each extension refer to
extension’s documentation page.
Here are a number of Honeybee popular extensions:
CLI Docs¶
For command line interface documentation and API documentation see the pages below.
honeybee¶
- honeybee
- honeybee package
- Subpackages
- Submodules
- honeybee.altnumber module
- honeybee.aperture module
- honeybee.boundarycondition module
- honeybee.checkdup module
- honeybee.colorobj module
- honeybee.config module
- honeybee.dictutil module
- honeybee.door module
- honeybee.extensionutil module
- honeybee.face module
- honeybee.facetype module
- honeybee.logutil module
- honeybee.model module
- honeybee.orientation module
- honeybee.properties module
- honeybee.room module
- honeybee.search module
- honeybee.shade module
- honeybee.shademesh module
- honeybee.typing module
- honeybee.units module
- Module contents
- honeybee package