heatpanel

Technical 3D model of a sheet-and-tube PV-T system's thermal characteristics and electrical performance

https://github.com/benwinchester/pvtmodel

Science Score: 44.0%

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

  • CITATION.cff file
    Found 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 (9.4%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Technical 3D model of a sheet-and-tube PV-T system's thermal characteristics and electrical performance

Basic Info
  • Host: GitHub
  • Owner: BenWinchester
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 46.2 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 8
  • Releases: 2
Created over 5 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

HEATPanel

2D model for a PVT system.

Model basics.

The model can be run as a python module from the command-line interface. The model exposes: * an overall method, for running the entire model including analysis; * an analysis module, which can be executed to run the figure generation only; * and an enforcement module.

The model aims to simulate the running of an integrated PV-T, hot-water, and load system. The system modelled consists of a PV-T panel component, a hot-water tank, and a system for simulating the demands placed on the system by the end user.

Running the Model

The model can be executed with python3.7 from a command line by calling: python3.7 -m pvt_model.

The model can be run as a decoupled panel or as an integrated (coupled) system.

For running the model, the following CLI arguments are required as a minimum: * --initial-month <month_number> - Specifies the month for which weather data should be used. * --location <location_folder> - Specifies the location-related information. For an example location, see the system_data/london folder. * --portion-covered <0-1> - Must be used to specify the portion of the panel which is covered with PV cells. * --pvt-data-file <pv_data_file.yaml> - The PV-T data YAML file must be specified. * --output <extension-independent output file name> - The name of the output file, to which data should be saved, independent of file extension, should be specified.

For running the model as a stand-alone (decoupled) panel, the following requirements are required as an addition to the minimum above: * --decoupled --steady-state - Must be used to specify that the run is decoupled and steady-state. * --steady-state-data-file <steady-state system data file> - Information about the runs that should be conducted needs to be specified. * --x-resolution <int> - Specifies the number of elements to use in the x-direction. * --y-resolution <int> - Specifies the number of elements to use in the y-direction.

For running the model as an integrated (coupled) panel, the following requirements are required as an addition to the minimum above: * --dynamic - Must be used to specifiy that the run is coupled and dynamic. * --exchanger-data-file <exchanger_data_file.yaml> - Must be used to specify the YAML data file for the heat exchanger. * --resolution <int> - The temporal resolution to use for the model. * --tank-data-file <tank_data_file.yaml> - Must be used to specify the YAML data file for the hot-water tank.

For ease of use, the following command-line arguments are recommended when conducting a dynamic and coupled run: * --average-irradiance - Stipulates that an average irradiance profile for the month must be used. * --start-time <int> - The start time, in hours from midnight, for which to run the simularion. 0 is the default;

For help with the arguments needed in order to run the model, use the inbuilt help display: python3.7 -m pvt_model --help.

NOTE: If you receive a KeyError: <int> on the command-line, it is likely that the argument --average-irradiance must be used. This is because solar-irradiance profiles are missing for certain days, and the command must be used to average over those profiles which are specified.

Running the Analysis Module

The analysis module can also be run from the command-line interface. This should be executed as a python module: py -m pvt_model.analysis -df <output_file_path_with_extension>.

Creating a Pull Request

All pull requests need to be approved by a repository administrator and need to pass a series of automated tests.

To confirm that your code will pass, run the scritp test-pvt-model.sh from the root of the repository to ensure that your code confirms to the standards required of the repository (regarding formatting and type annotations etc.), that all automated tests are passing, and that all type: ignore and pylint: disable flags are dedclared.

HPC Support

NOTE: Support is included to run the model on Imperial's high-performance computing (HPC) system. Scripts for deploying runs are located in the scripts directory. This directory can be safely ignored when deploying the model on a home-PC setup.

Copyright

Copyright Benedict Winchester, 2021

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Winchester
    given-names: Benedict
    orcid: https://orcid.org/0000-0002-2880-1243
  - family-names: Huang
    given-names: Gan
  - family-names: Nelson
    given-names: Jenny
    orcid: https://orcid.org/0000-0003-1048-1330
  - family-names: Markides
    given-names: Christos N.
    orcid: https://orcid.org/0000-0002-4219-1867
title: HEATPanel
version: v1.1
date-released: 2022-09-13
url: "https://github.com/BenWinchester/PVTModel"

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 568
  • Total Committers: 1
  • Avg Commits per committer: 568.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
BenWinchester b****r@g****m 568

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 19
  • Total pull requests: 32
  • Average time to close issues: 23 days
  • Average time to close pull requests: about 3 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.53
  • Average comments per pull request: 0.0
  • Merged pull requests: 28
  • 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
Top Authors
Issue Authors
  • BenWinchester (19)
Pull Request Authors
  • BenWinchester (32)
Top Labels
Issue Labels
bug (13) enhancement (6)
Pull Request Labels
bug (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 36 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: heatpanel

Hybrid Electric and Heat Panel Model

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 36 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 21.6%
Average: 27.8%
Forks count: 29.8%
Stargazers count: 31.9%
Downloads: 45.6%
Maintainers (1)
Last synced: 8 months ago