> For the complete documentation index, see [llms.txt](https://docs.ladybug.tools/dragonfly-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/dragonfly-primer/components/5_districtthermal/read_ghe_sizing.md). # Read GHE Sizing ![](/files/hQmdRlvvYI4SuCM7cwNy) ![](/files/rXnFfDyEhHTKPouoD0lc) - [\[source code\]](https://github.com/ladybug-tools/dragonfly-grasshopper/blob/master/dragonfly_grasshopper/src//DF%20Read%20GHE%20Sizing.py) Load properties of the Ground Heat Exchangers (GHEs) from the "DF Write Modelica DES" component. This includes the positions of boreholes in each GHE, the G-function of each GHE that describes the response of the ground to load, an a range of other properties output from the sizing simulation performed by GHEDesigner. ### Inputs * **sys\_param \[Required]** The system parameters JSON file output by the "DF Write Modelica DES" component. This includes the detailed Building load profiles, equipment specifications, and borehole field characteristics. * **des\_loop \[Required]** The GHE Thermal Loop object output by the "DF GHE Thermal Loop", which contains the geometry of the district energy system. * **ip** Boolean to note whether all outputs should be in SI or IP units. Setting this to True will result in all values in the report to IP and the month\_temps will be in F instead of C. (Default: False). ### Outputs * **report** Reports, errors, warnings, etc. * **boreholes** A list of points for the borehole locations within the \_site. * **bore\_geo** Script variable ColorNetAttr * **g\_function** A data tree of G-function coefficients that describe the response of the ground to the input loads. Each pair of factors represents a point on the G-function. Flattening this data tree enables you to plug it directly into the "Ironbug Ground Heat Exchanger Vertical" component to simulate the ground heat exchanger in EnergyPlus. * **properties** A list of properties for the GHE that can be used to describe it in EnergyPlus simulations. The properties that can be plugged directly into the parameters of the "Ironbug Ground Heat Exchanger Vertical" component. The properties are in the following order: ``` * Borehole Length * Borehole Radius * Design Flow Rate * Ground Temperature * Ground Conductivity * Ground Heat Capacity * Grout Conductivity * Number of Boreholes * Pipe Outer Diameter * Pipe Conductivity * Pipe Thickness * U Tube Distance ``` * **month\_temps** A list of ground temperatures in Celsius with one value for each month of the period over which the GHEDesigner simulation was run (typically 20 years). This can be connected to a nativ Grasshopper "Quick Graph" component and used to check the drift in the ground temperature over long periods of time. --- # 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/dragonfly-primer/components/5_districtthermal/read_ghe_sizing.md?ask=&goal= ``` `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.