Skip to content

gkennaugh/dash-electricity

Repository files navigation

Contributors Forks Stargazers Issues GNU License LinkedIn


Logo

Dashboard for Electricity Management

Dashboard to explore regional management of electricity generation locally
Explore the docs »

View Live Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

Dashboard to manage regionally generated electricity and usage within the United Kindgom.

(back to top)

Built With

  • Plotly
  • Bootstrap

The advantage of using plotly is everything from the front-end to the back-end is built using python. No need to learn javascript and seamlessly put online with https://pythonanywhere.com (free account to get you going). Pythonanywhere has most python packages installed on their own side so you just need to put your .py file and it should run straight away.

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Install Python (better to use Anaconda https://www.anaconda.com/)

Installation

  1. Clone the repo

    git clone https://github.com/gkennaugh/dash-electricity.git
  2. Install required packages from requirements.txt

    pip install -r requirements.txt
  3. Run python app.py in a new Anaconda Command Prompt

    python app.py

    Open the app in your local browser at http://localhost:8064

N.B. You can use my api key to begin with but please get your own free key here https://www.mapbox.com/

(back to top)

Usage

To monitor locally generated electricity from renewable sources eg. wind farms, solar, biomass. To detect shortages in electricity generation due to low wind speeds for example. To monitor the hourly electricity demand of a region, split into small subgroups of approximately 1000 homes and businesses, and to see if enough power will be generated based on forecasts. The map can be adjusted to show shortfalls in electricity generation and which areas of the region may suffer powercuts.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [-] Map info (location and predicted wind speed for wind farms, solar panels and biomass)
  • [-] Demand for each area and potential shortfalls based on estimated electricity generation hourly
  • [ ] Include battery storage levels

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle) - [email protected]

Project Link: https://github.com/gkennaugh/dash-electricity

(back to top)

Acknowledgments

(back to top)

Releases

No releases published

Packages

No packages published

Languages