Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Home Energy Assessment Database

Documentation, conversions, and data supporting Climate Cooperative's home energy audit and calculation tools.
https://github.com/climate-cooperative/home-energy-assessment-database

Category: Consumption
Sub Category: Buildings and Heating

Keywords

carbon-emissions climate climate-change climate-change-mitigation climate-data climate-solutions energy energy-consumption energy-data energy-efficiency sustainability sustainability-assessment sustainable-development-goals

Last synced: about 21 hours ago
JSON representation

Repository metadata

Documentation, conversions, and data supporting Climate Cooperative's home energy audit and calculation tools.

README.md

Home Energy Assessment Database API 🌎

Welcome to the Climate Cooperative Open Source project! As a social purpose corporation, Climate Cooperative is dedicated to advancing carbon-neutral, sustainable energy solutions for homes. Our mission is to foster diverse, healthy communities by providing innovative and accessible energy efficiency tools and services.

The primary goal of the Home Energy Assessment Database API is to consolidate diverse data sources into a unified platform that enables accurate calculation of a home's carbon footprint. This calculation will consider various factors, including local energy grid mix, weather conditions, and specific home attributes such as age, size, construction materials, and mechanical systems. The project aims to address the critical need for accessible and reliable data to support the development of home energy savings calculators, enable detailed analyses, and facilitate the creation of visualizations pertaining to residential home energy consumption and efficiency.

This platform seeks to empower climate tech startups, academic researchers, and other stakeholders with the data necessary to innovate, study, and propose solutions aimed at reducing residential energy consumption and its environmental impact. By providing a comprehensive and easily accessible API, the project aspires to catalyze advancements in home energy efficiency, support policy development, and contribute to a more sustainable future.

Climate Cooperative Integration

The Home Energy Assessmant Database acts as the RESTful API for the home-energy calculator, hvac controller(future), and the heat pump water heater savings calculator(future).

The future purpose for this service is to act as the middle man between a dataset which holds the information which is then used to perform complex, home energy calculations. Where these calculations and results get served to is up to you! Look here for some ideas around that.

Local Development ⚡️⚡️

Make sure you have docker running locally

Environment Setup

Follow the steps provided in the env-setup doc.

./start_local.sh

Database Connection

We use localstack to emulate dynamodb locally so we don't need to connect to a real database when dveloping.

Data and tables are hydrated in init_dynamodb.sh. Feel free to add data as you want to enable better dev experience.

Keep an eye on this (project)[https://github.com/climate-cooperative/home-energy-data-manager] for improvements around data 🚀

Contributing 🎉🥳🙏

Want to get involved? Take a look at our CONTRIBUTING DOC

Technology Used

REST

DATABASE ACCESS

Testing

Climate Cooperative 🌎

Learn more about the Climate Cooperative.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 12 days ago

Total Commits: 188
Total Committers: 7
Avg Commits per committer: 26.857
Development Distribution Score (DDS): 0.33

Commits in past year: 12
Committers in past year: 3
Avg Commits per committer in past year: 4.0
Development Distribution Score (DDS) in past year: 0.333

Name Email Commits
rgraue r****e@o****m 126
Shilo Jones 1****s 28
Jaret Keniston 1****n 19
cooper-roper c****r@h****m 9
Simon Fishel s****f@g****m 3
Ryan Graue r****e@R****l 2
Eric Cairns e****s@f****m 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 39
Total pull requests: 43
Average time to close issues: 28 days
Average time to close pull requests: 1 day
Total issue authors: 2
Total pull request authors: 4
Average comments per issue: 0.26
Average comments per pull request: 0.12
Merged pull request: 40
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 7
Past year average time to close issues: 3 months
Past year average time to close pull requests: 5 days
Past year issue authors: 1
Past year pull request authors: 3
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.14
Past year merged pull request: 6
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/climate-cooperative/home-energy-assessment-database

Top Issue Authors

  • rgraue (35)
  • cooper-roper (4)

Top Pull Request Authors

  • rgraue (38)
  • sfishel18 (3)
  • shilojones (1)
  • queue74 (1)

Top Issue Labels

  • API (17)
  • assessment-database (17)
  • MVP (7)
  • good first issue (2)

Top Pull Request Labels

  • API (3)
  • assessment-database (3)

Dependencies

Dockerfile docker
  • base latest build
  • node iron-alpine3.18 build
nginx/Dockerfile docker
  • nginx latest build
server/package.json npm
  • dotenv ^16.3.1 development
  • eslint ^8.55.0 development
  • eslint-plugin-react ^7.33.2 development
  • nodemon ^3.0.3 development
  • axios ^1.6.2
  • cors ^2.8.5
  • express ^4.18.2
  • mongodb ^6.3.0
  • mongoose ^8.1.0
  • node-cron ^3.0.3

Score: 4.584967478670571