This is no longer maintained, active development is in openelec
A tool for optimising rural mini-grid systems using OpenStreetMap building data and a minimum spanning tree approach to network optimisation.
Provides model features through a simple API, as well as a basic Flask web app.
See the blog post here for a general overview of the model development (probably out of date): https://rdrn.me/flask-optimize-minigrid/
Have a look at the example Jupyter Notebook for a quick overview of the main API features:
Web App usage
minigrid-optimiser requires Python >= 3.5 with the following packages installed:
flask>= 1.0.2 (only for the web app)
geopandas>= 0.4.0 (0.4.0 had API breaking changes so this version is needed)
Downloads or clone the repository:
git clone https://github.com/carderne/minigrid-optimiser.git
cd into the directory, and install the required packages into a virtual environment:
pip install -r requirements.txt
jupyter notebook and open
minigrid-optimiser.ipynb to go over the main model usage and API.
To use the web app, run the following from the main directory:
cd mgo python mgo_app.py
and navigate to http://127.0.0.1:5000/ in a browser to access the web app.