Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.59 KB

README.md

File metadata and controls

42 lines (26 loc) · 1.59 KB
Raw

Description

This open-source computer tool is part of the PeopleSuN project, which contains a web-based app that aims to optimize the network structure as well as the power supply system for mini-grid systems.

The features of the tool are listed below:

  • Automatic identification of buildings from the OpenStreetMap inside a given boundary.
  • Network optimization of mini-grids based on the Python package sgdot-lite.
  • Optimization of the power supply systems for mini-grids (PV, battery, and diesel) using a Python-based tool called Offgridders.
  • Automatic identification of buildings that are better to be served by idividual solar home systems.

Get started

Installation

  1. From the root of the repository, first create a virtual environment (here called venv) using the following command: python3 -m venv venv

or if you want to install a specific version of python, first install virtualenv and then: virtualenv venv --python=python_version

Note that conda can also be used to set up a virtual environment

  1. Activate the virtual environment running the following command:

i. On Linux, MacOs source venv/bin/activate

ii. On Windows venv\Scripts\activate

  1. Install the required packages using the following command: pip install -r requirements.txt

Launching of the app

  1. Run the following command to start the FastAPI server: uvicorn fastapi_app.main:app --reload

  2. Open the following URL in a browser (preferably on Chrome or Firefox): http://127.0.0.1:8000/