Home Energy Analysis Tool

Provide an app that helps residential energy coaches or advocates, and some homeowners, estimate a home's heating requirements (heat load) and assess whether proposed heat pumps have sufficient heating capacity for the home.
https://github.com/codeforboston/home-energy-analysis-tool

Category: Consumption
Sub Category: Buildings and Heating

Keywords from Contributors

code-for-america code-for-boston

Last synced: about 5 hours ago
JSON representation

Repository metadata

Calculator app improving state of art in heat pump sizing with Heat Smart Alliance coaches

README.md

Goal: Provide an app that helps residential energy coaches or advocates, and some homeowners, estimate a home's heating requirements (heat load) and assess whether proposed heat pumps have sufficient heating capacity for the home. The app will use information about the home including it's location, usual thermostat settings, and historical energy usage, provided by the resident, to calculate the heating requirements in BTUs/hr. Key outputs will include two graphs, one showing the heating requirement vs. outdoor temperature and another comparing the home with other homes based on floor area. In the future, this app may be extended to provide more information, such an estimate of electricity use by a heat pump, cost of heating with a heat pump vs. fossil fuel and other such features.

Users: Heatsmart Alliance coaches, energy coaches with other affiliations, and users of the CfB sibling project.

Current method: An Excel spreadsheet with formulas that perform the calculations. Inputs to the existing spreadsheet include historic energy usage, typical thermostat settings, and temperature data from a weather station close to the home. More info on this existing spreadsheet and a link to request a download are available from the HeatSmart Alliance at this link.

Teams

UI/UX and/or Design

This team will work with the other teams to match the interface and necessary research together.

JavaScript

This team will plan and build the user interface. React and Remix in Epic Stack. Uses Pyodide to run python code on frontend.
It will also get information from the weather station API that the rules engine can use for its calculations. In the future, it may work on permissions and persistence of household data.

Rules Engine

This team will help convert or read the existing spreadsheet logic into something the app can act upon. Uses numpy and Python: likely to run in-browser rather than on backend.

Auth/Persistence

This team will determine the best way to allow users to store their past cases with the households they visit. Likely to use SQLite and Prisma in Epic Stack.

Installation

To install the front end, see this README.md

Documentation

For the Heat Stack (Javascript) portion read: README.md
For the Rules Engine (Python) portion read: README.md


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 244
Total Committers: 31
Avg Commits per committer: 7.871
Development Distribution Score (DDS): 0.783

Commits in past year: 90
Committers in past year: 15
Avg Commits per committer in past year: 6.0
Development Distribution Score (DDS) in past year: 0.711

Name Email Commits
Alan Pinkert a****t@g****m 53
Thad Kerosky c****t@t****t 46
AdamFinkle 7****e 28
mciethan e****x@g****m 24
Jonathan Kwan j****1 13
Ethan-Strominger 3****r 12
Harry Zhu h****6@g****m 11
Jeff Korenstein 6****n 10
Erika Nesse e****e@g****m 7
eriksynn 1****n 6
Nate 1****r 4
K Fuquay k****y@g****m 4
Derek McIntire 7****e 3
Debajyoti Debnath d****h@p****u 2
stemgene 3****e 2
dwindleduck 1****k 2
Vlad Korolev v****d@v****g 2
Devin Altobello 1****o 2
thatoldplatitude 9****e 1
spghtti 2****i 1
plocket 5****t 1
TBardini t****5@g****m 1
Steve Breit 6****t 1
Matthew Zagaja m****a 1
Kate Shea d****a@g****m 1
Jacob Paris j****b@j****m 1
Ivy Wong i****g 1
Gavin Kimball 1****o 1
Ethan Zhang 3****a 1
Debajyoti Debnath 9****2 1
and 1 more...

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 207
Total pull requests: 270
Average time to close issues: about 2 months
Average time to close pull requests: 18 days
Total issue authors: 24
Total pull request authors: 36
Average comments per issue: 1.05
Average comments per pull request: 0.66
Merged pull request: 199
Bot issues: 0
Bot pull requests: 0

Past year issues: 116
Past year pull requests: 152
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 12 days
Past year issue authors: 12
Past year pull request authors: 19
Past year average comments per issue: 0.61
Past year average comments per pull request: 0.55
Past year merged pull request: 108
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/codeforboston/home-energy-analysis-tool

Top Issue Authors

  • AdamFinkle (43)
  • thadk (35)
  • jkwan2011 (28)
  • ethanstrominger (19)
  • alanisaac (16)
  • plocket (13)
  • baipai (11)
  • debajyotid2 (9)
  • stevebreit (5)
  • pravindransolutions (5)
  • eriksynn (4)
  • derekvmcintire (3)
  • mciethan (3)
  • jkoren (2)
  • axiomizer (2)

Top Pull Request Authors

  • thadk (57)
  • AdamFinkle (53)
  • alanisaac (43)
  • ethanstrominger (35)
  • jkoren (11)
  • thatoldplatitude (7)
  • eriksynn (7)
  • derekvmcintire (5)
  • vladistan (5)
  • stemgene (4)
  • mciethan (4)
  • axiomizer (4)
  • kfuquay (4)
  • dwindleduck (3)
  • plocket (2)

Top Issue Labels

  • rules-engine (70)
  • good first issue (22)
  • heat-app-js (21)
  • user-experience (12)
  • heat-app (8)
  • enhancement (5)
  • build (4)
  • documentation (2)
  • on hold (1)
  • bug (1)
  • image (1)

Top Pull Request Labels

  • heat-app-js (7)
  • on hold (1)
  • do not merge (1)
  • rules-engine (1)

Score: 8.08794755464267