Welcome to Honeybee Energy's documentation!
===========================================

.. image:: http://www.ladybug.tools/assets/img/honeybee.png

`EnergyPlus <https://energyplus.net//>`_ extension for `honeybee <https://github.com/ladybug-tools/honeybee-core/>`_

Honeybee-energy adds EnergyPlus/OpenStudio functionalities to honeybee for energy simulation.


Installation
============

``pip install -U honeybee-energy``.

If you want to also include the command line interface try:

``pip install -U honeybee-energy[cli]``.

To check if the command line is installed correctly try ``honeybee energy --help`
or ``honeybee-energy --help``


Documentation
=============

For command line interface documentation and API documentation see the pages below.


.. toctree::
   :maxdepth: 2

   cli/index
   api
