Home - emmdim/guifiAnalyzer GitHub Wiki

Welcome to the guifiAnalyzer wiki!

Intro

guifiAnalyzer is a python project aspiring to be a monitoring/research tool collecting information from guifi.net.

This information can be either:

  • infrastructure information (based on the CNML information of the network)
  • traffic information (based on the information deployed by the already deployed SNPservices services of guifi.net)

Subprojects

guifiAnalyzer is currently consisted from 4 different subprojects as well as a db backend, which connects the project to MongoDB.

  • guifiwrapper can be considered the main backend, but can be also used to get information. guifiwrapper is a tool to grab CNML information about a guifi.net zone and its subzones. The CNML calls on the guifi.net web server are based on libcnml. The rest of the subprojects use guifiwrapper to grab whatever infrastructural information is needed.

  • plot is a tool that produces certain plots with statistics for guifi.net. It has as a goal to set as an example how to plot using information from guifiwrapper.

  • vis is an unfinished effort to create visualizations of graphs extracted with guifiwrapper using D3.js.

  • traffic is a tool that extract traffic information for the nodes of a guifi.net zone, asking the responsible graph servers.

TODO

  • Streamline installation (maybe Docker?): create directories, install system packages (python-dev|python-devel;lxml:libxml2, libxslt; matplotlib: libpng-dev,libfreetype6-dev,pkg-config; mongo-db), virtualenv, install python packages, connect to guifi.net network
  • Streamline usage
  • ?Show live statistics? (Check Dash Framework)