Welcome to the frontend of Energeo, a React-based web application designed to visualize real-time energy sourcing and environmental impact data. Our goal is to promote sustainable practices and raise awareness through interactive graphs and images. EnerGeo was developed during a hackathon themed "Earth, Fire, Air, Water - Where does our energy come from?". By integrating MLOps, Cloud, and AI technologies, EnerGeo channels data from various APIs and leverages advanced LLM-based technologies. We aspire to provide users with a comprehensive tool that facilitates a direct and easier understanding of the environmental impact of energy sources, and our unique take is classifying them into the four aforementioned elements. Currently EnerGeo offers visualizations of historical consumption levels in the UK (last 30 minutes and last 24 hours) and features an AI image generator that provides real-time visualizations of weather conditions in any location around the world.
- Project Team
- Key Features
- Tech Stack
- Libraries and APIs
- EnerGeo Backend GitHub Repository
- Getting Started
- Project Structure
- Key Components
- Data Sources
- Acknowledgements
- Contributing
-
Frontend Engineer:
-
Data Scientists:
- Real-time energy sourcing dashboard
- Interactive carbon intensity map
- Weather visualisation with EnerGenius
- Responsive design for various screen sizes
Before proceeding with the installation, make sure you have the following installed:
- Node.js: version 18.x or higher
- npm: version 7.x or higher
- Clone the repository:
git clone https://github.com/yourusername/energeo.git- Navigate to the project directory:
cd energeo- Install dependencies:
npm install- Create a
.envfile in the root directory and add your Google Maps API key:
VITE_GOOGLE_MAPS_API_KEY=your_api_key_here- Start the development server:
npm run dev- Open your browser and navigate to
http://localhost:5173(or the port specified by Vite).
src/: Contains the source code for the applicationcomponents/: Reusable React componentspages/: Main page componentsstyles/: CSS filesutils/: Utility functions and constantsassets/: Static assets like imagespublic/: Public assets
- Dashboard: Visualises energy sourcing data
- Carbon Intensity Map: Displays real-time carbon intensity across Great Britain
- EnerGenius: Weather visualisation tool
Elexon provide an API that offers data about the UK energy network.
The carbon intensity forecast API is made by National Grid ESO, in partnership with the Environmental Defense Fund Europe, University of Oxford, and WWF.
We use solar energy generation forecast data provided by University of Sheffield solar. We get solar generation forecast by PES region.
We query a free weather API for current weather data in a specified location.
We downloaded a publicly available file from National Grid ESO's data portal. Contains data up to 17th July 2024. Find link to current document below.
Also from national grid data portal is a GeoJSON file that contains the coordinates of UK regions. We use regions current at May 2024.
- Andrew Crossland, PhD inspired our project with his real-time web-based tool, mygridgb.co.uk, and offered us constant support and encouragement throughout the hackathon.
- Anna Putt for organizing the MentorMe initiative and its first hackathon, "Earth, Fire, Air, Water - Where Does Our Energy Come From?", and Ben Fairbairn for coming up with the theme. We had the honour of winning the hackathon with this project!
- Le Wagon - London trained us and provided an excellent co-working space in the heart of London for the duration of the hackathon.
Contributions are welcome! Please feel free to submit a Pull Request.