Coder Social home page Coder Social logo

sfishel18 / home-energy-assessment-database Goto Github PK

View Code? Open in Web Editor NEW

This project forked from climate-cooperative/home-energy-assessment-database

0.0 0.0 0.0 1.6 MB

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

License: Apache License 2.0

Shell 34.08% JavaScript 0.52% TypeScript 63.39% Dockerfile 2.00%

home-energy-assessment-database's Introduction

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

Lets keep this simple.

./start_local.sh

Environment Setup

Follow the steps provided in the env-setup doc.

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

Climate Cooperative ๐ŸŒŽ

Learn more about the Climate Cooperative.

home-energy-assessment-database's People

Contributors

rgraue avatar shilojones avatar jaretkeniston avatar cooper-roper avatar sfishel18 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.