Welcome to Ladybug Comfort's documentation!
===========================================

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

Ladybug-comfort is a Python library that adds thermal comfort functionalities to
`ladybug-core <https://github.com/ladybug-tools/ladybug/>`_.

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

``pip install -U ladybug-comfort``

If you want to also include the dependencies needed for thermal mapping use.

``pip install -U honeybee-energy[mapping]``

To check if the command line interface is installed correctly use ``ladybug-comfort --help``


CLI Docs
=============

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


.. toctree::
   :maxdepth: 2

   cli/index


ladybug_comfort
===============

.. toctree::
  :maxdepth: 4

  modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`