Skip to content

Commit 203fd0b

Browse files
authored
Update README.md
Added description of script features
1 parent 458ace5 commit 203fd0b

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
While histogram and KDE (kernel density estimation) can represent scattering of the data almost correctly, can not represent statistical values.
88

99
I recommend to use violinplot, as violinplot is a complex of KDE and box plot.
10+
## Features
11+
- Read CSV file, containing input latency, to create violinplot, kdeplot and histgraph images. (CSV file containing data on input latency (ms) with no headers and units, separated by line feeds).
12+
- In the input window you can enter a title for the graph, a description of the test and the test environment. These are added to the graph and make the graph more visible. (If left blank, they are omitted.)
13+
- Images are saved in the outputs folder. (If the outputs folder does not exist, it will be created automatically.)
14+
- Use the graph title and graph type as the file name when saving the image. This ensures that the contents of the graph can be understood from the file name alone.
15+
- Add a four-digit number to the end of the filename of the image. Avoid overwriting by changing the four-digit number when the same filename is used.
1016

1117
## Contents
1218
- [violinplot_KDElike.py](violinplot_KDElike.py) -> Script to graph input latency data with violinplot
@@ -20,8 +26,9 @@
2026
- [histgraph_step.py](histgraph_step.py) -> Script to graph input latency data with histgraph in step mode
2127
![preview_step](outputs/preview_histgraph_step.png)
2228

23-
## requisite
24-
- csv file containing data on input latency(ms) with no headers and units, separated by line feeds
29+
## Requirements
30+
- Windows OS(Vista or 8 or later, depending on Python version)
31+
- CSV file containing data on input latency(ms) with no headers and units, separated by line feeds
2532
- python3.8+
2633
- pandas module
2734
- seaborn module
@@ -35,7 +42,7 @@
3542
- (in Optional Features, you have to check tcl/tk and IDLE to install tkinter module)
3643
2. Run the below in CMD to install the required modules.
3744
- `pip install pandas seaborn matplotlib msvc-runtime`
38-
- (if you installed Microsoft Visual C++ Redistributable Package, you dont need msvc-runtime.)
45+
- (if you installed Microsoft Visual C++ Redistributable Package, you dont need msvc-runtime module.)
3946
3. run python file and select csv files.
4047
4. Enter GraphTitle and TestSetup,TestInfo.(if you left blank, it will be omitted)
4148
5. Plot image is in outputs folder.

0 commit comments

Comments
 (0)