Data

Tools

Indexes

Applications

Experiments

Open Source Science

ThermalNetwork

https://github.com/NREL/ThermalNetwork

Science Score: 26.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: NREL
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 31.5 MB
Statistics
  • Stars: 4
  • Watchers: 6
  • Forks: 8
  • Open Issues: 3
  • Releases: 20
Created about 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License

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/testoutput/_

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

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Create event: 26
  • Release event: 6
  • Issues event: 14
  • Watch event: 3
  • Delete event: 15
  • Member event: 1
  • Issue comment event: 49
  • Push event: 85
  • Pull request review comment event: 69
  • Pull request review event: 71
  • Pull request event: 46
  • Fork event: 7
Last Year
  • Create event: 26
  • Release event: 6
  • Issues event: 14
  • Watch event: 3
  • Delete event: 15
  • Member event: 1
  • Issue comment event: 49
  • Push event: 85
  • Pull request review comment event: 69
  • Pull request review event: 71
  • Pull request event: 46
  • Fork event: 7

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 240
  • Total Committers: 6
  • Avg Commits per committer: 40.0
  • Development Distribution Score (DDS): 0.521
Past Year
  • Commits: 74
  • Committers: 3
  • Avg Commits per committer: 24.667
  • Development Distribution Score (DDS): 0.149
Top Committers
Name Email Commits
Nathan Moore n****e@n****v 115
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 5
Nathan Moore v****e@p****e 1
Committer Domains (Top 20 + Academic)
nrel.gov: 4 proton.me: 1 ladybug.tools: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 17
  • Total pull requests: 92
  • Average time to close issues: 9 days
  • Average time to close pull requests: 12 days
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.35
  • Average comments per pull request: 1.24
  • Merged pull requests: 74
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 52
  • Average time to close issues: 7 days
  • Average time to close pull requests: 5 days
  • Issue authors: 4
  • Pull request authors: 3
  • Average comments per issue: 0.4
  • Average comments per pull request: 1.35
  • Merged pull requests: 40
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • vtnate (8)
  • tanushree04 (5)
  • chriswmackey (3)
  • mitchute (1)
Pull Request Authors
  • vtnate (70)
  • mitchute (14)
  • chriswmackey (8)
Top Labels
Issue Labels
bug (4) enhancement (3) tests (2) ignore for release (2)
Pull Request Labels
enhancement (45) ignore for release (13) tests (12) bug (11) documentation (6) question (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 148 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 16
  • Total maintainers: 2
pypi.org: thermalnetwork

A thermal network solver for GHE sizing.

  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 148 Last month
Rankings
Dependent packages count: 7.5%
Average: 31.4%
Dependent repos count: 55.3%
Maintainers (2)
mitchute vtnate
Last synced: 11 months ago