Welcome to lbt-recipes' documentation!
=======================================

A collection of recipes that ship with the Ladybug Tools plugins.

This includes Radiance recipes, which automate the process of running daylight and radiation studies using `Radiance <https://radiance-online.org/>`_.

It also includes microclimate mapping recipes, which spatially map thermal comfort using `EnergyPlus <https://github.com/NREL/EnergyPlus/>`_ and `Radiance <https://radiance-online.org/>`_.

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

To install the library use ``pip install -U lbt-recipes``.

To check if the command line interface is installed correctly use ``lbt-recipes viz`` and you
should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!

CLI Docs
========

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

.. toctree::
   :maxdepth: 2

   cli//index


lbt_recipes
=============

.. toctree::
  :maxdepth: 4

  modules

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

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