Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 4.77 KB

README.md

File metadata and controls

101 lines (68 loc) · 4.77 KB

PyPSA-Earth Dashboard: Nigeria Test Bench

Project Description

The PyPSA-Earth Dashboard offers an interactive mapping and data visualization platform for energy systems analysis. Specifically personalized to examine Nigeria's electrical grid, this tool implements technologies such as OpenLayers, Django, and PostGIS to visualize the network architecture and optimized installed capacity.

Features

  • Interactive Mapping: Explore detailed visualizations of Nigeria's electrical grid and geographic features through an OpenLayers interface.
  • Data Visualization: Utilize Chart.js to view and interact with energy data through dynamic charts and graphs.
  • Real-Time Search: Find specific country locations or infrastructure components within the interactive map.
  • Customizable Data Layers: Toggle various data layers to focus on different aspects of energy infrastructure, such as Network Statistics or existing grid structures.

Installation

Prerequisites

To run this project, ensure you have the following installed:

  • Conda for managing the environment.
  • Redis for caching management.

Environment Setup

  1. Fork and clone the Repository link:

    # e.g., git clone https://github.com/your-user/energy-gis-dashboard.git
    cd PyPSAEarthDashboard
    
  2. Create and Activate the Conda Environment:

    conda env create -f environment.yml
    conda activate dashboard_env
    
  3. Start Redis Server: Make sure your Redis server is running, as it handles caching and session management:

    redis-server
  4. Database Setup: Adjust the .env file with your database and Redis connection settings.

    python manage.py migrate
    # A database backup is provided in the form of an SQL file named `PyPSAEarthDashboard.sql`. This file can be used to easily restore the database using pgAdmin, a popular database management tool for PostgreSQL.
    

Usage

To use the dashboard:

  1. Start the Django Server:

    python manage.py runserver

    This command starts a local web server. To access the dashboard, navigate to http://localhost:8000 in your web browser.

  2. Explore the Dashboard:

    • Utilize the layer controls in the sidebar to toggle different data layers.
    • Use the search bar to navigate to specific locations quickly.
    • View various statistics through charts and graphs.

Contributing

Would you be interested in contributing? Great! You can contribute by forking the repository, making changes, and submitting a pull request. You can also report bugs or suggest new features by opening issues.

Credits

This project was financed by the program "Junge Innovatoren (JI)" of the Federal State of Baden-Württemberg and developed in collaboration with the Karlsruhe Institute of Technology (KIT) Karlsruhe Institute of Technology (KIT), Open Energy Transition (OET), and Stuttgart University of Applied Sciences.

junge-innovatoren_4c bw100_gr_4c_mwk kit-logo-color oet-logo-red-n-subtitle

License

This project is open-source under the GNU Affero General Public License v3.0. The LICENSE folder in this repository provides more details.

REUSE status

Contact

Please get in touch with Bryan Ramirez and Ekaterina Fedotova for further information or support.