Metadata-Version: 2.1
Name: sgdot
Version: 1.2
Summary: UNKNOWN
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Platform: UNKNOWN
Requires-Dist: amply (==0.1.2)
Requires-Dist: appdirs (==1.4.4)
Requires-Dist: attrs (==19.3.0)
Requires-Dist: backcall (==0.2.0)
Requires-Dist: bleach (==3.1.5)
Requires-Dist: cycler (==0.10.0)
Requires-Dist: decorator (==4.4.2)
Requires-Dist: defusedxml (==0.6.0)
Requires-Dist: docutils (==0.16)
Requires-Dist: entrypoints (==0.3)
Requires-Dist: flake8 (==3.8.3)
Requires-Dist: func-timeout (==4.3.5)
Requires-Dist: importlib-metadata (==1.6.1)
Requires-Dist: ipykernel (==4.10.0)
Requires-Dist: ipython (==7.15.0)
Requires-Dist: ipython-genutils (==0.2.0)
Requires-Dist: ipywidgets (==7.5.1)
Requires-Dist: jedi (==0.17.0)
Requires-Dist: Jinja2 (==2.11.2)
Requires-Dist: joblib (==0.16.0)
Requires-Dist: jsonschema (==3.2.0)
Requires-Dist: jupyter (==1.0.0)
Requires-Dist: jupyter-client (==6.1.3)
Requires-Dist: jupyter-console (==6.1.0)
Requires-Dist: jupyter-core (==4.6.3)
Requires-Dist: kiwisolver (==1.2.0)
Requires-Dist: kneed (==0.7.0)
Requires-Dist: MarkupSafe (==1.1.1)
Requires-Dist: matplotlib (==3.2.2)
Requires-Dist: mccabe (==0.6.1)
Requires-Dist: mistune (==0.8.4)
Requires-Dist: more-itertools (==8.4.0)
Requires-Dist: munkres (==1.1.2)
Requires-Dist: nbconvert (==5.6.1)
Requires-Dist: nbformat (==5.0.7)
Requires-Dist: nose (==1.3.7)
Requires-Dist: notebook (==6.0.3)
Requires-Dist: numpy (==1.18.4)
Requires-Dist: opencv-python (==4.2.0.34)
Requires-Dist: packaging (==20.4)
Requires-Dist: pandas (==1.0.5)
Requires-Dist: pandocfilters (==1.4.2)
Requires-Dist: parso (==0.7.0)
Requires-Dist: pexpect (==4.8.0)
Requires-Dist: pickleshare (==0.7.5)
Requires-Dist: pluggy (==0.13.1)
Requires-Dist: ply (==3.11)
Requires-Dist: prometheus-client (==0.8.0)
Requires-Dist: prompt-toolkit (==3.0.5)
Requires-Dist: ptyprocess (==0.6.0)
Requires-Dist: PuLP (==2.2)
Requires-Dist: py (==1.8.2)
Requires-Dist: pycodestyle (==2.6.0)
Requires-Dist: pyflakes (==2.2.0)
Requires-Dist: Pygments (==2.6.1)
Requires-Dist: pyparsing (==2.4.7)
Requires-Dist: pyrsistent (==0.16.0)
Requires-Dist: pytest (==5.4.3)
Requires-Dist: python-dateutil (==2.8.1)
Requires-Dist: pytz (==2020.1)
Requires-Dist: PyUtilib (==6.0.0)
Requires-Dist: pyzmq (==19.0.1)
Requires-Dist: qtconsole (==4.7.4)
Requires-Dist: QtPy (==1.9.0)
Requires-Dist: scikit-learn (==0.23.2)
Requires-Dist: scipy (==1.5.0)
Requires-Dist: Send2Trash (==1.5.0)
Requires-Dist: six (==1.15.0)
Requires-Dist: sklearn (==0.0)
Requires-Dist: terminado (==0.8.3)
Requires-Dist: testpath (==0.4.4)
Requires-Dist: threadpoolctl (==2.1.0)
Requires-Dist: tornado (==6.0.4)
Requires-Dist: traitlets (==4.3.3)
Requires-Dist: wcwidth (==0.2.4)
Requires-Dist: webencodings (==0.5.1)
Requires-Dist: widgetsnbextension (==3.5.1)
Requires-Dist: zipp (==3.1.0)

**SG-DOT**

SGDOT is a Package created to help design and optimize the network
topology for swarm-grids. It uses satellite imagery of villages to be
electrified and enables designing and optimizing a grid with a tree-star
configuration.

The grids module containes the Grid class. A grid essentially contains two
DataFrames representing the nodes and the links composing the network as well as
a set of attributes representing the price of the grid's components.
The nodes represent houses to be connected to the grid and the links represent
wires connecting pairs of houses together. There is a price associated with
each link and node. The price of a Grid is the sum of the prices of each
nodes and links.

The tools sub-package contains the **grid_optimizer, grid_visualizer, io** and **plot** modules.

- The **grid_optimizer** modules encapsulates GridOptimizer class which contains methods for optimizing a Grid object.
- The **grid_visualizer** modules encapsulates GridVisualizer class which contains methods for visualise a Grid object using opencv.
- The **io** module contains functions to handle files.
- The **plot** module enables to display the grid object in a 2D plot as well as displaying the plot of the results of the optimizations


