Software installation

Requirements

QGIS

OnSSET is a spatial electrification tool and as such highly relies on the usage of Geographic Information Systems (GIS). A GIS environment is therefore necessary for two main reasons:

  • Extract trivial characteristics for the electrification analysis from GIS layers and combine them all together in a format easy to read in python (a .csv file with all the attributes per population point).
  • Visualize the final results in maps.

Historically OnSSET has relied on ArcGIS, but recently the process has been moved to open source GIS environments. OnSSET in it’s current form relies on QGIS (together with in QGIS included tools from SAGA, GDAL and GRASS)

Download QGIS for free from the official website.

Python - Anaconda package

OnSSET is written in python, an open source programming language used widely in many applications. Python is a necessary requirement for the OnSSET tool to work. Programming in python usually relies on the usage of pre-defined functions that can be found in the so called modules. In order to work with OnSSET, certain modules need to be installed/updated. The easiest way to do so is by installing Anaconda, a package that contains various useful modules. Anaconda includes all the modules required to run OnSSET successfully. Python itself can be downloaded and installed for free from the official website.

Python Interfaces - Integrated Development Environment (IDEs)

  • PyCharm

Integrated Development Environments are used in order to ease the programming process when multiple or long scripts are required. There are plenty of IDEs developed for Python, KTH dESA has been using PyCharm as the standard IDE to run OnSSET.

  • Jupyter notebook (via Anaconda)

Jupyter notebook is a console-based, interactive computing approach providing a web-based application suitable for capturing the whole computation process: developing, documenting, and executing code, as well as communicating the results. Jupyter notebook is used for the online OnSSET interface, recommended for small analyses and exploring code and results.

GitHub

GitHub is a web-based Git repository hosting service. It provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project. OnSSET is an open source tool therefore the code behind it is open and freely accessible to any user. The code behind the OnSSET tool is called “PyOnsset” and is available in KTH dESA’s Github space. A GitHub account will allow you to propose changes, modifications and upgrades to the existing code. Access KTH dESA’s repository on Github.

Software installation and setup

  1. Download Anaconda here and install.
  • Please make sure that you download the version that is compatible with your operating system (Windows/MacOS/Linux - In case you run Windows open the Windows Control Panel, go to System and Security System and check e.g. Windows 32-bit or 64-bit).
  • Following the installation process make sure that you click on the option “Add Python X.X to PATH”. Also by choosing to customize the installation, you can specify the directory of your preference (suggest something convenient e.g. C:/Python35/..).
  • After the installation you can use the Anaconda command line (search for “Anaconda Prompt”) to run python. It should work by simply writing “python” and pressing enter, since the path has already been included in the system variables. In case this doesn’t work, you can either navigate to the specified directory and write “python” there, or add the directory to the PATH by editing the environment variables.
  1. Download PyCharm here and install.
  • Please make sure that you download the version that is compatible with your operating system. Select the “Community”, open-source version.
  1. Download the code from GitHub here.

Additional info

  • Basic navigating commands for DOS (cmd) can be found here.
  • Modules and packages installation documentation from python.org .