# Shade

![](/files/-Mihnyn1STi1HcUgAzfO)

![](/files/-Mihnyn2AG9OIIc8mOZg) - [\[source code\]](https://github.com/ladybug-tools/honeybee-grasshopper-core/blob/master/honeybee_grasshopper_core/src//HB%20Shade.py)

Create Honeybee Shade.

### Inputs

* **geo \[Required]**

Rhino Brep or Mesh geometry.

* **name**

Text to set the name for the Shade and to be incorporated into unique Shade identifier. If the name is not provided, a random name will be assigned.

* **attached**

Boolean to note whether the Shade is attached to other geometry. This is automatically set to True if the Shade is assigned to a parent Room, Face, Aperture or Door but will otherwise defalt to False. If the Shade is not easily assignable to a parent object but is attached to the building (eg. a parapet or large roof overhang), then this should be set to True. (Default: False).

* **ep\_constr**

Optional text for the Shade's energy construction to be looked up in the construction library. This can also be a custom construction object. If no energy construction is input here, a default will be assigned.

* **ep\_trans\_sch**

Optional text for the Shade's energy transmittance schedule to be looked up in the schedule library. This can also be a custom schedule object. If no energy schedule is input here, the default will be always opaque.

* **rad\_mod**

Optional text for the Shade's radiance modifier to be looked up in the modifier library. This can also be a custom modifier object. If no radiance modifier is input here, a default will be assigned.

### Outputs

* **report**

Reports, errors, warnings, etc.

* **shades**

Honeybee shades. These can be used directly in radiance and energy simulations.


---

# Agent Instructions: 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:

```
GET https://docs.ladybug.tools/honeybee-primer/components/0_create/shade.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.