Jupyter notebook facilitated for extracting GIS data and generating the input file necessary for OnSSET. The notebook can be utilized when generating an OnSSET input file from scratch or when the user wants to change one specific dataset in an existing OnSSET-input file. The mandatory datasets are \n:
- Administrative boundaries
- Global horizontal irradiation
- Travel time
- Wind velocity
- Clusters (Note The clusters have to include the name of the study area, population, and an ID column)
Optional datasets that can be used for the extraction are:
- Custom Demand - A layer that can be created by the users themselves. For the first round of GEP the methodlogy described here has been used.
- Substations
- Transformers
- Mini/Small hydro
- Existing and planned HV-lines
- Existing and planned MV-lines
- Existing mini-grid locations
- Road network
The output is in the form of a CSV file that can be directly put into OnSSET.
This repository contains:
- An environment .yml file needed for generating a fully functioning python 3.12 environment necessary for the clustering algorithm.
- The clustering code and related functions. These files also have instructions for how to run the code
- An example case for Benin containing inputs and outputs
Requirements
The extraction module (as well as all supporting scripts in this repo) have been developed in Python 3. You are recommended to install Anaconda's free distribution as suited for your operating system.
Install the extraction repository from GitHub
After installing Anaconda you can download the repository directly or clone it to your designated local directory using:
> conda install git
> git clone https://github.com/OnSSET/OnSSET_GIS_Extraction_notebook.git
Once installed, open anaconda prompt and move to your local "OnSSET-GIS-Extraction" directory using:
> cd ..\OnSSET-GIS-Extraction
In order to be able to run the tool (main.ipynb and funcs.ipynb) you have to install all necessary packages. "onsset_env.yml" contains all of these and can be easily set up by creating a new virtual environment using:
conda env create --name OnSSET --file onsset_env.yml
This might take some time. When complete, activate the virtual environment using:
conda activate OnSSET
With the environment activated, you can now move to the extraction directory and start a "jupyter notebook" session by simply typing:
..\OnSSET-GIS-Extraction> jupyter notebook
21-Februray-2021: Original code base published 3-September-2025: Major update to user-friendliness and processing speed