Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

ThermalNetwork

A library for sizing multiple ground heat exchangers distributed around a single-pipe thermal network.
https://github.com/NREL/ThermalNetwork

Category: Renewable Energy
Sub Category: Geothermal Energy

Last synced: about 13 hours ago
JSON representation

Repository metadata

README.md

ThermalNetwork

A library for sizing multiple ground heat exchangers distributed around a single-pipe thermal network.

Installation

pip install ThermalNetwork

Documentation

Available at https://nrel.github.io/ThermalNetwork/

Usage

This package has a command-line interface, intended to be used via URBANopt. To access the CLI directly, after installing call thermalnetwork --help for all the commands.

Developer installation

  • Clone the repository: git clone https://github.com/NREL/ThermalNetwork.git
  • Change directories into the repository: cd ThermalNetwork
  • We recommend using virtual environments on principle to avoid dependencies colliding between your Python projects. venv is the Python native solution that will work everywhere, though other options may be more user-friendly.

Once you have set up your environment:

  • Update pip and setuptools: pip install -U pip setuptools
  • Install the repository with developer dependencies: pip install -e .[dev]
  • Activate pre-commit (only once, after making a new venv): pre-commit install
    • Runs automatically on your staged changes before every commit
    • Includes linting and formatting via ruff
  • To check the whole repo, run pre-commit run --all-files
    • Settings and documentation links for pre-commit and ruff are in .pre-commit-config.yaml and ruff.toml
    • Pre-commit will run automatically during CI, linting and formatting the entire repository.

Testing

Once you are set up as a developer, run pytest from the root dir. Increase verbosity with -v and -vv.

Test coverage results will be saved to htmlcov/index.html.

Test files are in tests/

Test output will be written to tests/test_output/

Releasing

Versioning is done by GitHub tag, thanks to SetupTools-SCM. Use semantic versioning when tagging. When a new release is made in GitHub, a workflow automatically publishes to PyPI.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 232
Total Committers: 5
Avg Commits per committer: 46.4
Development Distribution Score (DDS): 0.53

Commits in past year: 71
Committers in past year: 3
Avg Commits per committer in past year: 23.667
Development Distribution Score (DDS) in past year: 0.155

Name Email Commits
Nathan Moore n****e@n****v 109
Matt Mitchell m****l@n****v 67
brianlball b****l@n****v 45
Tanushree t****n@n****v 7
Chris Mackey c****s@l****s 4

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 18
Total pull requests: 49
Average time to close issues: about 1 month
Average time to close pull requests: 15 days
Total issue authors: 4
Total pull request authors: 3
Average comments per issue: 0.94
Average comments per pull request: 1.31
Merged pull request: 43
Bot issues: 0
Bot pull requests: 0

Past year issues: 11
Past year pull requests: 24
Past year average time to close issues: 13 days
Past year average time to close pull requests: 15 days
Past year issue authors: 4
Past year pull request authors: 3
Past year average comments per issue: 1.27
Past year average comments per pull request: 2.08
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/NREL/ThermalNetwork

Top Issue Authors

  • vtnate (8)
  • tanushree04 (6)
  • chriswmackey (3)
  • mitchute (1)

Top Pull Request Authors

  • vtnate (34)
  • mitchute (11)
  • chriswmackey (4)

Top Issue Labels

  • bug (4)
  • enhancement (3)
  • tests (2)
  • ignore for release (2)

Top Pull Request Labels

  • enhancement (23)
  • ignore for release (8)
  • bug (6)
  • tests (6)
  • documentation (3)
  • question (1)

Package metadata

pypi.org: thermalnetwork

A thermal network solver for GHE sizing.

  • Homepage: https://github.com/NREL/ThermalNetwork
  • Documentation: https://thermalnetwork.readthedocs.io/
  • Licenses: bsd-3-clause
  • Latest release: 0.3.3 (published 5 months ago)
  • Last Synced: 2025-06-26T07:01:40.298Z (1 day ago)
  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 88 Last month
  • Rankings:
    • Dependent packages count: 7.519%
    • Average: 31.408%
    • Dependent repos count: 55.297%
  • Maintainers (2)

Score: 7.90100705199242