Welcome to Fairyfly's documentation!
=========================================

.. image:: https://raw.githubusercontent.com/ladybug-tools/artwork/refs/heads/master/icons_bugs/png/fairyfly-small.png

Fairyfly is a collection of Python libraries to create representations of construction details
following `fairyfly-schema <https://github.com/ladybug-tools/fairyfly-schema/wiki>`_.

This package is the core library that provides fairyfly's common functionalities.
To extend these functionalities you should install available Fairyfly extensions or write
your own.

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

To install the core library try ``pip install -U fairyfly-core``.

To check if the Fairyfly command line interface is installed correctly try ``fairyfly viz`` and you
should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!


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

This document includes `Fairyfly API documentation <#fairyfly>`_ and
`Fairyfly Command Line Interface <#cli-docs>`_ documentation for ``fairyfly core`` and does
not include the documentation for fairyfly extensions. For each extension refer to
extension's documentation page.

Here are a number of Fairyfly popular extensions:

- `fairyfly-therm <https://ladybug.tools/fairyfly-therm/docs>`_


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

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


.. toctree::
   :maxdepth: 2

   cli/index


fairyfly
=============

.. toctree::
   :maxdepth: 4

   modules

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

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