search

UBC-MDS / DSCI-532_2024_9_solar-savers

A dashboard application helping Canadian homeowners in solar panel purchasing decisions.
https://dsci-532-2024-9-solar-savers.onrender.com/
Other
0 stars 1 forks source link
chart dropdown map slider

readme

Solar Savers 🌞

A dashboard application helping Canadian homeowners in solar panel purchasing decisions.

Our Purpose

❌ The Problem

The global need to shift towards sustainable energy sources has been recognized for decades, but its urgency continues to escalate. At the consumer-level, this problem is compounded by the rise in inflation and challenging decisions required when purchasing items like solar panels.

✅ Our Solution

With this escalating inflation and growing environmental consciousness, consumers across Canada seek to save money where they can. Solar Savers, a user-friendly app, is designed to better equip homeowners in the decision-making process of purchasing solar panels for their home. With user's location, electricity rates, and panel quality, Solar Savers allows users to see their potential electricity and financial savings. It provides the required knowledge to assess the value of investing in solar panels and facilitates the decision-making process overall.

Usage

🔍Try out the App!

To start using the Solar Savers dashboard, click here: Solar Savers Dashboard.

On the dashboard, embark on your journey by selecting your location, roof dimensions (optional), desired number of panels, and panel efficiency. Can't decide between two panels? Let our panel comparison widget at the bottom guide your decision.

Get started and watch in awe as your electricity and financial savings rise!

Demo

🌱 Get involved!

If you are interested in contributing to the development of the Solar Savers dashboard, please read the contributing guidelines for full details. Below are some quick steps to run the dashboard locally.

  1. Clone the repository locally. In your terminal run:

    $ git clone https://github.com/UBC-MDS/DSCI-532_2024_9_solar-savers.git

  2. Create and activate the conda environment. In the root of the repository run:

    $ conda env create --file environment.yml
    $ conda activate solar-savers

  3. Create a branch for local development and make your changes:

    $ git checkout -b name-of-your-fix-or-feature

  4. To run the dashboard, from the root of the directory (DSCI-532_2024_9_solar-savers) run: 

    $ python -m src.app

  5. Click on the displayed link to open view the dashboard on a browser.

Contributing

Interested in contributing to this project? Check out the contributing guidelines. Please note: This project is released with a Code of Conduct. By contributing to this project, you agree to abide by the terms in the Code of Conduct.

Contact Us

If you'd like to suggest a new feature or if you experience a problem while using the dashboard, please open an issue. For problems, please include:

License

Solar Savers is developed and maintained by Marco Bravo, Nicole Bidwell, Rafe Chang, and Sam Fo. The code is licensed under the MIT License, Open Canada License, and Creative Commons License. Please see LICENSE.md for details.

Additional Credits

📈 Data Sources