pygfunction

An open source toolbox for the evaluation of thermal response factors of geothermal borehole fields.
https://github.com/MassimoCimmino/pygfunction

Category: Renewable Energy
Sub Category: Geothermal Energy

Keywords from Contributors

buildings geothermal energyplus heatexchanger heatpump modelica modelica-library

Last synced: about 22 hours ago
JSON representation

Repository metadata

An open-source toolbox for the evaluation of thermal response factors (g-functions) of geothermal borehole fields.

• Host: GitHub
• URL: https://github.com/MassimoCimmino/pygfunction
• Owner: MassimoCimmino
• License: bsd-3-clause
• Created: 2017-08-14T20:13:54.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2025-08-04T09:31:51.000Z (5 months ago)
• Last Synced: 2025-12-10T19:48:39.946Z (20 days ago)
• Language: Python
• Homepage:
• Size: 1.35 MB
• Stars: 58
• Watchers: 9
• Forks: 25
• Open Issues: 32
• Releases: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Citation: CITATION.cff

README.md

import pygfunction as gt
import numpy as np
time = np.array([(i+1)*3600. for i in range(24)]) # Calculate hourly for one day
boreField = gt.boreholes.rectangle_field(N_1=10, N_2=10, B_1=7.5, B_2=7.5, H=150., D=4., r_b=0.075)
gFunc = gt.gfunction.gFunction(boreField, alpha=1.0e-6, time=time)
gFunc.visualize_g_function()

pip install pygfunction[plot]

pip install .

git clone https://github.com/MassimoCimmino/pygfunction.git

pip install --editable .

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Cimmino"
  given-names: "Massimo"
  orcid: "https://orcid.org/0000-0002-9981-9926"
title: "pygfunction"
version: 2.3.0
date-released: 2025-04-29
url: "https://github.com/MassimoCimmino/pygfunction"
preferred-citation:
  type: conference-paper
  title: "pygfunction 2.2 : New Features and Improvements in Accuracy and Computational Efficiency"
  authors:
  - family-names: "Cimmino"
    given-names: "Massimo"
    orcid: "https://orcid.org/0000-0002-9981-9926"
  - family-names: "Cook"
    given-names: "Jonathan C."
  doi: "10.22488/okstate.22.000015"
  start: 45 # First page number
  end: 52 # Last page number
  year: 2022
  collection-type: proceedings
  collection-title: "Research Conference Proceedings, IGSHPA Conference 2022"
  publisher:
    name: International Ground Source Heat Pump Association
  institution:
    name: International Ground Source Heat Pump Association
  collection-doi: 10.22488/okstate.22.000010
  location: Las Vegas NV, USA
  editors:
  - family-names: "Spitler"
    given-names: "Jeff"
  - family-names: "Acuña"
    given-names: "José"
  - family-names: "Bernier"
    given-names: "Michel"
  - family-names: "Cimmino"
    given-names: "Massimo"
  - family-names: "Fang"
    given-names: "Zhaohong"
  - family-names: "Gehlin"
    given-names: "Signhild"
  - family-names: "Javed"
    given-names: "Saqib"
  - family-names: "Liu"
    given-names: "Xiaobing"
  - family-names: "Rees"
    given-names: "Simon"
  - family-names: "Stumpf"
    given-names: "Andrew"
  conference:
  - name: International Ground Source Heat Pump Association Annual Conference
    city: Las Vegas
    region: NV
    country: USA
    date-start: 2022-12-06
    date-end: 2022-12-08

Owner metadata

• Name: Massimo Cimmino
• Login: MassimoCimmino
• Email:
• Kind: user
• Description:
• Website: https://www.polymtl.ca/expertises/en/cimmino-massimo
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/23085996?u=389b819cb55c6c6280881a4a89bda52f83b66a5f&v=4
• Repositories: 6
• Last ynced at: 2024-06-11T15:44:25.863Z
• Profile URL: https://github.com/MassimoCimmino

GitHub Events

Total

• Create event: 10
• Release event: 1
• Issues event: 14
• Watch event: 7
• Delete event: 1
• Issue comment event: 33
• Push event: 32
• Pull request review event: 8
• Pull request review comment event: 15
• Pull request event: 20
• Fork event: 2

Last Year

• Create event: 8
• Release event: 1
• Issues event: 10
• Watch event: 3
• Issue comment event: 18
• Push event: 26
• Pull request review event: 8
• Pull request review comment event: 15
• Pull request event: 17
• Fork event: 1

Committers metadata

Last synced: 3 days ago

Committer domains:

• nrel.gov: 3
• okstate.edu: 2
• set-l-me-l16007.luna.kuleuven.be: 1
• meca.polymtl.ca: 1
• polymtl.ca: 1

Issue and Pull Request metadata

Last synced: 6 days ago

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 8,653 last-month
• Total dependent packages: 3 (may contain duplicates)
• Total dependent repositories: 2 (may contain duplicates)
• Total versions: 49
• Total maintainers: 1

Dependencies

Score: 16.051070841566066