search

2Max4 / Network_Analysis

Collection of useful scripts to analyse the local network and evaluate network speed and velocity
MIT License
2 stars 11 forks source link

Update Read_Me with further instructions #26

Open 2Max4 opened 4 years ago

2Max4 commented 4 years ago

Update the existing Read_me with further instructions for installation and usage of the Network_Analysis - also adding images and examples would be great.

bhadreshpsavani commented 4 years ago

I can work on this issue, but I need to understand more about our code and the installation flow

2Max4 commented 4 years ago

@bhadreshpsavani Great! Which information do you need?

Just to get started some general information:

The repo consists of several folders and files. The "first layer" files are the ones that are most important. Currently network_test.py as well as network_test_class.py are pretty much the same just with the small difference, that network_test_class.py is build up as a class and will be used in future extension. By running both files you will start a network test. You can find the different options in the argument parser. If you run those files they will send ping requests to a server (that you can define) and if the ping time droppes below a specific threshold (which you can set) it will automatically test the current speed of your internet connection. Both observations will be stored in 2 sepperate CSV files which location you can set in the arguments. Default is the Data dirctory.

Visuals.py is a class that can automatically generate plots (which are also produced in the notebook) and export them to the folder webpage/figures. If figures dosen't exist in your clone - do not worry - it will be build automatically.

Analytics.ipynb is a notebook where Data wrangling and visualization is made. It is used to analyze the statistics that have been catched during running the network_test.py /network_test_class.py.

For installation the requirements.txt musst be installed via pip. Make sure that everything is run as sudo when you are on Linux because this is the only way to get access to the IP Layer on Linux.

If you've got further questions - feel free to ask!

2Max4 commented 4 years ago

@bhadreshpsavani I saw on your profile that you are also firm with ML - if you like to feel free to make a notebook concerning Feature Generation and some unsupervised learning based on the 2 CSV files in the Data Directory. (You first have to run the network_test.py in order to generate them)

the corresponding Issue would be #7

Guo2006 commented 4 years ago

Hi. I can try to create good README with instructions for users, program desription and installation guide. Also I see that you need some updates in your webpage. If you will explain me what do you want I can create css file or something. During this process I will get familiar with your code and maybe will make some code pull request. My diploma work was kind of network pinger. And this is my first steps in open source development...

bhadreshpsavani commented 4 years ago

Hello @2Max4 I would love to apply machine learning in the issue #7 In India, we have traditional festivals this week i might not get much time, i will start working by monday on both of the above issues Thanks you for the in depth explanation about Repository.

2Max4 commented 4 years ago

@bhadreshqsavani awesome! Enjoy your festivals! Maybe it is better if you Fokus in ml and @Guo2006 creates the read me related stuff! I think this may be more effective!

@Guo2006 could you start with the read me?

rishabhrkaushik commented 4 years ago

Hi @2Max4, I was going through the code and created a very basic version of README for my understanding. The same README could be elaborated forward. Adding pull request for the same.PR #39. I also added a test script in the same.

2Max4 commented 4 years ago

Already merged it - will add more information asap