Data

Tools

Indexes

Applications

Experiments

Open Source Science

ghedt

The Ground Heat Exchanger Design Tool can simulate, size and automatically select ground heat exchanger configurations.

https://github.com/j-c-cook/ghedt

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

geothermal heatexchanger heatpump
Last synced: 10 months ago · JSON representation

Repository

The Ground Heat Exchanger Design Tool can simulate, size and automatically select ground heat exchanger configurations.

Basic Info
  • Host: GitHub
  • Owner: j-c-cook
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 16.9 MB
Statistics
  • Stars: 10
  • Watchers: 3
  • Forks: 1
  • Open Issues: 9
  • Releases: 5
Topics
geothermal heatexchanger heatpump
Created about 5 years ago · Last pushed over 3 years ago
Metadata Files
Readme Changelog Contributing 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.

polygonal

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): angular2html pip install ghedt

Developers - Clone the repository to via git: angular2html 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:

angular2html 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: angular2html @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

  • Name: Jack Cook
  • Login: j-c-cook
  • Kind: user

GitHub Events

Total
  • Watch event: 1
  • Fork event: 1
Last Year
  • Watch event: 1
  • Fork event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 432
  • Total Committers: 4
  • Avg Commits per committer: 108.0
  • Development Distribution Score (DDS): 0.148
Past Year
  • Commits: 22
  • Committers: 1
  • Avg Commits per committer: 22.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email 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 (Top 20 + Academic)
nrel.gov: 1 okstate.edu: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • 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 requests: 50
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • j-c-cook (38)
  • DavideDC9 (3)
  • NicholasFry (2)
  • mitchute (2)
  • XiaoliLiu94 (1)
Pull Request Authors
  • j-c-cook (52)
  • mitchute (2)
Top Labels
Issue Labels
bug (4) maintenance (3) enhancement (2) tests (1) change (1) new feature (1) do not publish (1)
Pull Request Labels
change (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 29 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.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 29 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 18.5%
Dependent repos count: 21.6%
Average: 21.7%
Forks count: 22.6%
Downloads: 35.6%
Maintainers (1)
GeneralCode
Last synced: 10 months ago

Dependencies

requirements.txt pypi
  • 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
setup.py pypi
  • 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
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-tests-linux.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-tests-macos.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/python-tests-windows.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite