home-energy-analysis-tool

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

https://github.com/codeforboston/home-energy-analysis-tool

Science Score: 36.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
    2 of 35 committers (5.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

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

Basic Info
Statistics
  • Stars: 18
  • Watchers: 10
  • Forks: 41
  • Open Issues: 69
  • Releases: 0
Created about 3 years ago · Last pushed 10 months ago
Metadata Files
Readme License

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.

Original 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. Original figma is available here (https://www.figma.com/design/qaxsZ6TW7gjQdUGjuPypZ5/heat-tool-design---new-one-?node-id=2080-12489&p=f)

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 dataREADME.md.

Rules Engine

Rules engine provides reading, validation and calculations for heat data that are read from the 2 gas companies National Grid and Eversource. https://docs.google.com/document/d/1-CAsHL1WhCPQW8iXA_XXgSUWHZsCKiTsPHOVz9eV0AE/edit?tab=t.0

Definitions:

Balance point: Outdoor temperature beyond which no heating is required.
Inclusion code: winter=1|spring=0|summer=-1|fall=0( determines the months to be used for heat load calculations)
Thermostat set point: the temp in F at which the home is normally set.
setback_temperature: temp in F at which the home is set during  off hours.
setback_hours_per_day: average # of hours per day the home is at setback temp.
design_set_point: a standard internal temperature / thermostat it can be read for a county from helpers.py.
set point - different from the preferred set point of an individual homeowner.
avg_indoor_temp: average indoor temperature on a given day 
`((24 - setback_hours_per_day) * thermostat_set_point + setback_hours_per_day * setback_temperature) / 24`
design_temp: an outside temperature that represents one of the coldest days of the year for the given location of a home.
ua: the heat transfer coefficient
hdd: heating degree days on a given day for a given home `(Balance Point-avg_indoor_temp)`.
dhw: heat used for non heating purposes.
maximun heat load: `(design_set_point - design_temp) * ua`

Documentation:

    - design_temp [README.md](/design_temp/README.md)

Calculations:

The data files for each home is used to calculate the heat load for the home irrespective of the fuel type used. The data is normalized to be fuel type agnostic and the intermediate bill that is generated converts temperature data and billing period inputs into internal classes used for heat loss calculations.

Validations:

1.Validate the csv for the heating company National Gird/Eversource

Tests:

Tests for Engine:

    - Generating intermediate bill
    - Generating Normalized bill
    - Calculate Non heating usage

Tests for Parser:

    - Identify gas company
    - Error of neither of the 2 Nation Grid/ Eversource

Auth

Role based Authorization, used from epic stack. For further documentation refer to https://github.com/epicweb-dev/epic-stack/blob/main/docs/permissions.md?plain=1

Persistence

The epic stack has the default schemas in prisma.schema. The models specific to the project are placed after the default models in the same file. Migrations are run during the heat-stack setup. Updates to the model will create new migrations as necessary.

Deploy

The epic stack uses Fly.io for default deployment. This application works with it out of the box. The documentation is here https://github.com/epicweb-dev/epic-stack/blob/main/docs/deployment.md

Installation

To install the front end, see this README.md

To install the rules engine, see this README.md

Documentation

Further reading can be done here (https://drive.google.com/drive/folders/1z8dBfvQD78AAt7VI2z3J3YVubFNDpq-O)

Owner

  • Name: Code for Boston
  • Login: codeforboston
  • Kind: organization
  • Email: hello@codeforboston.org
  • Location: Boston, MA

Improving civic life and social good in Greater Boston.

GitHub Events

Total
  • Create event: 126
  • Issues event: 209
  • Watch event: 6
  • Delete event: 140
  • Member event: 3
  • Issue comment event: 197
  • Push event: 380
  • Pull request review comment event: 55
  • Pull request review event: 73
  • Pull request event: 251
  • Fork event: 9
Last Year
  • Create event: 126
  • Issues event: 209
  • Watch event: 6
  • Delete event: 140
  • Member event: 3
  • Issue comment event: 197
  • Push event: 380
  • Pull request review comment event: 55
  • Pull request review event: 73
  • Pull request event: 251
  • Fork event: 9

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 279
  • Total Committers: 35
  • Avg Commits per committer: 7.971
  • Development Distribution Score (DDS): 0.81
Past Year
  • Commits: 119
  • Committers: 20
  • Avg Commits per committer: 5.95
  • Development Distribution Score (DDS): 0.655
Top Committers
Name Email Commits
Alan Pinkert a****t@g****m 53
Thad Kerosky c****t@t****t 50
AdamFinkle 7****e 43
mciethan e****x@g****m 24
Ethan-Strominger 3****r 17
Jonathan Kwan j****1 13
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
plocket 5****t 4
K Fuquay k****y@g****m 4
Derek McIntire 7****e 3
ZaimaGull Z****l@G****m 3
Devin Altobello 1****o 2
Vlad Korolev v****d@v****g 2
Debajyoti Debnath d****h@p****u 2
pravindransolutions p****v@g****m 2
stemgene 3****e 2
nikulabs n****s@g****m 2
dwindleduck 1****k 2
Clayton Schneider 5****r 1
Debajyoti Debnath 9****2 1
Ethan Zhang 3****a 1
Gavin Kimball 1****o 1
Ivy Wong i****g 1
Jacob Paris j****b@j****m 1
Kate Shea d****a@g****m 1
Matthew Zagaja m****a 1
and 5 more...
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 243
  • Total pull requests: 464
  • Average time to close issues: 3 months
  • Average time to close pull requests: 13 days
  • Total issue authors: 24
  • Total pull request authors: 39
  • Average comments per issue: 0.78
  • Average comments per pull request: 0.59
  • Merged pull requests: 320
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 147
  • Pull requests: 273
  • Average time to close issues: 19 days
  • Average time to close pull requests: 8 days
  • Issue authors: 12
  • Pull request authors: 21
  • Average comments per issue: 0.35
  • Average comments per pull request: 0.41
  • Merged pull requests: 178
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • AdamFinkle (54)
  • ethanstrominger (50)
  • thadk (33)
  • jkwan2011 (24)
  • alanisaac (15)
  • plocket (12)
  • baipai (9)
  • debajyotid2 (8)
  • stevebreit (6)
  • pravindransolutions (5)
  • eriksynn (4)
  • derekvmcintire (3)
  • mciethan (3)
  • jkoren (3)
  • interianow (3)
Pull Request Authors
  • AdamFinkle (96)
  • thadk (95)
  • ethanstrominger (73)
  • alanisaac (52)
  • jkoren (18)
  • eriksynn (14)
  • thatoldplatitude (12)
  • derekvmcintire (10)
  • interianow (10)
  • kfuquay (8)
  • stemgene (8)
  • vladistan (8)
  • plocket (5)
  • pravindransolutions (4)
  • mciethan (4)
Top Labels
Issue Labels
rules-engine (60) user-experience (29) good first issue (20) heat-app-js (16) question (10) documentation (6) technical (5) heat-app (4) enhancement (4) build (3) security (3) breakout (3) close? (2) sub-issue (2) on hold (1) must have (1) should have (1)
Pull Request Labels
heat-app-js (7) on hold (2) do not merge (2) rules-engine (1)