> For the complete documentation index, see [llms.txt](https://docs.ladybug.tools/ironbug-primer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ladybug.tools/ironbug-primer/readme.md).

# Ironbug Primer

![Ironbug](https://raw.githubusercontent.com/ladybug-tools/artwork/refs/heads/master/icons_bugs/png/ironbug-small.png)

This primer provides an overview of the Ironbug components for Grasshopper.

Ironbug enables the creation of highly detailed and customizable HVAC, SHW, and electricity generation systems for [Honeybee](https://docs.ladybug.tools/honeybee-primer/) and [Dragonfly](https://docs.ladybug.tools/dragonfly-primer/).

## Installation

See the [Readme of the Ironbug repository](https://github.com/MingboPeng/Ironbug?tab=readme-ov-file#installation) for the installation instructions.

## Resources

Post your questions to [Ladybug Tools forum](http://discourse.ladybug.tools) and see the [Ironbug](https://github.com/MingboPeng/Ironbug) repository for source code.

Please [let us know](https://github.com/MingboPeng/Ironbug/issues) if you find any mistakes in grammar or spelling in this primer and we will gladly fix them.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ladybug.tools/ironbug-primer/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.