Ground Heat Exchanger Design Tool
A package with the novel capability of automatically selecting ground heat exchanger configurations based on polygonal land constraints.
https://github.com/j-c-cook/ghedt
Category: Renewable Energy
Sub Category: Geothermal Energy
Keywords
geothermal heatexchanger heatpump
Last synced: about 11 hours ago
JSON representation
Repository metadata
The Ground Heat Exchanger Design Tool can simulate, size and automatically select ground heat exchanger configurations.
- Host: GitHub
- URL: https://github.com/j-c-cook/ghedt
- Owner: j-c-cook
- License: bsd-3-clause
- Created: 2021-06-16T23:00:32.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-12T22:30:05.000Z (about 2 years ago)
- Last Synced: 2025-03-22T19:02:16.623Z (about 1 month ago)
- Topics: geothermal, heatexchanger, heatpump
- Language: Python
- Homepage:
- Size: 16.9 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 9
- Releases: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
README.md
Ground Heat Exchanger Design Tool
A package with the novel capability of automatically selecting ground heat
exchanger configurations based on polygonal land constraints. This package
contains advanced methods that are the first of their kind. The results are
validated against the world renowned GLHEPRO (Cook 2021).
The Ground Heat Exchanger Design Tool (DT) is a Python package that can
quantify the short- and long-term thermal interaction in a ground heat exchanger
(GHE). The long-term thermal response g-functions are computed live-time with
pygfunction. The DT contains a fast monthly hybrid time step
simulation for prediction of heat pump entering fluid temperatures over a design
life. The DT can vary the size (or borehole height) of a specified borehole field
to ensure the heat pump entering fluid temperature remains within specified
bounds. DT contains a novel borehole configuration selection algorithm.
Novel Design Algorithms
DT contains a novel design methodology for automated selection of borehole
fields. The advanced methodology performs optimization based on a target
drilling depth. An integer bisection routine is utilized to quickly search
over a unimodal domain of boreholes. DT can consider available drilling and
no-drilling zones defined as polygons.
The selection process shown below is performed in less than half a minute on an
11th Gen Intel Core i9-11900K @ 3.50GHz. Refer to Cook (2021) for more
information.
Requirements
ghedt requires at least Python 3.7 and is tested with Python 3.7 and 3.8, and is dependent on the following packages:
- pygfunction (>=2.1)
- numpy (>=1.19.2)
- scipy (>=1.6.2)
- matplotlib (>=3.3.4)
- coolprop (>=6.4.1)
- pandas (>=1.3.2)
- openpyxl (>=3.0.8)
- opencv-python (==4.5.4.58)
Quick Start
Users - Install ghedt via the package installer for Python (pip):
pip install ghedt
Developers - Clone the repository to via git:
git clone https://github.com/j-c-cook/ghedt
See installation
for more notes on installing. See ghedt/examples/
for usage.
Citing the Design Tool
The Ground Heat Exchanger Design Tool and other related work is described in the following thesis:
Cook, J.C. (2021). Development of Computer Programs for Fast Computation of
g-Functions and Automated Ground Heat Exchanger Design. Master's Thesis,
Oklahoma State University, Stillwater, OK.
Here is an example of a BibTeX entry:
@mastersthesis{Cook_2021,
school = "{Oklahoma State University, Stillwater, OK}",
author = {Cook, J C.},
language = {eng},
title = "{Development of Computer Programs for Fast Computation of g-Functions
and Automated Ground Heat Exchanger Design}",
year = {2021},
}
Questions?
If there are any questions, comments or concerns please create an
issue, comment on an open issue, comment on a closed issue,
or start a discussion.
Acknowledgements
The initial release of this work (ghedt-v0.1) was financially supported by the U.S. Department of Energy contract DE‐AC05‐00OR22725 through research subcontracts from Oak Ridge National Laboratory. Dr. Jeffrey D. Spitler was integral to the successful development, mostly through advice and feedback.
Owner metadata
- Name: Jack Cook
- Login: j-c-cook
- Email:
- Kind: user
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/39248734?u=48045686b0e39079fc3a98a8a5eb4e1a507e9a06&v=4
- Repositories: 20
- Last ynced at: 2025-04-24T12:26:49.433Z
- Profile URL: https://github.com/j-c-cook
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers metadata
Last synced: 7 days ago
Total Commits: 432
Total Committers: 4
Avg Commits per committer: 108.0
Development Distribution Score (DDS): 0.148
Commits in past year: 22
Committers in past year: 1
Avg Commits per committer in past year: 22.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| j-c-cook | j****k@o****u | 368 |
| j-c-cook | j****k@p****m | 62 |
| JackCook | J****k@j****l | 1 |
| Matt Mitchell | m****l@n****v | 1 |
Committer domains:
- nrel.gov: 1
- okstate.edu: 1
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 46
Total pull requests: 54
Average time to close issues: about 2 months
Average time to close pull requests: 8 days
Total issue authors: 5
Total pull request authors: 2
Average comments per issue: 1.35
Average comments per pull request: 0.17
Merged pull request: 50
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- j-c-cook (38)
- DavideDC9 (3)
- NicholasFry (2)
- mitchute (2)
- XiaoliLiu94 (1)
Top Pull Request Authors
- j-c-cook (52)
- mitchute (2)
Top Issue Labels
- bug (4)
- maintenance (3)
- enhancement (2)
- tests (1)
- change (1)
- new feature (1)
- do not publish (1)
Top Pull Request Labels
- change (1)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 91 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 2
- Total maintainers: 1
pypi.org: ghedt
A ground heat exchanger design tool with the advanced and unmatched capability of automatic borehole field selection based on drilling geometric land constraints.
- Homepage: https://github.com/j-c-cook/ghedt
- Documentation: https://ghedt.readthedocs.io/
- Licenses: bsd-3-clause
- Latest release: 0.3.1 (published about 2 years ago)
- Last Synced: 2025-04-26T12:02:52.886Z (1 day ago)
- Versions: 2
- Dependent Packages: 0
- Dependent Repositories: 1
- Downloads: 91 Last month
-
Rankings:
- Dependent packages count: 10.118%
- Stargazers count: 18.524%
- Dependent repos count: 21.552%
- Average: 21.679%
- Forks count: 22.649%
- Downloads: 35.553%
- Maintainers (1)
Dependencies
- coolprop >=6.4.1
- matplotlib >=3.3.4
- numpy >=1.19.2
- opencv-python ==4.5.4.58
- openpyxl >=3.0.8
- pandas >=1.3.2
- pygfunction >=2.1
- scipy >=1.6.2
- Pillow >=8.1.0
- coolprop >=6.4.1
- matplotlib >=3.3.4
- natsort >=7.1.1
- numpy >=1.19.2
- opencv-python ==4.5.4.58
- openpyxl >=3.0.8
- pandas >=1.3.2
- pygfunction >=2.1
- scipy >=1.6.2
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
Score: 8.80926561216931