Merge pull request #1 from migalabs/prepare-release/v2

Prepare for release v2

Author: tdahar

README.md

@@ -1,80 +1,25 @@
-# eth-client-hw-analysis V1
-Repo compiling all the images that came out from our Ethereum Consensus Client's hardware resource analysis 
+# Ethereum Consensus Clients Hardware Analysis V2
+This repository collects all the scripts and generates the figures used in the Ethereum Consensus Client's hardware resource analysis. 
 
-# Data Plotting
-This subfolder contains the tool used to plot the output data from the eth2-client-analyzer.
+## The Analysis
+This Analysis was performed during the month of May in 2023.
+It consisted of running the 5 main clients (Prysm, Lighthouse, Teku, Nimbus and Lodestar)
 
-This tool does not reveal / create / modify any data, it purely reads and represents the collected data into a plot.
-This tool has been developed in Python.
+## Running the clients
 
-Maintained by [MigaLabs](http://migalabs.io)
+In order to run the 5 main CL clients we have developed our own Ethereum docker-compose setup that can be used 
+to launch them in a single command. Please refer [here](https://github.com/migalabs/nodeth) for more information.
 
+## Data Collection
 
-## Requirements
+Data has been collected using a Jupyter Notebook and a Prometheus. Please refer to the `report.ipynb` file, where you may find a page containing the data collection details.
+After the execution, you may find several CSV files have been downloaded (under `{network}/csv/`).
 
-<strong>This tool has been tested using Python 3.8.10</strong>
-It merely needs the Python interpreter to run it and to install the dependencies in the requirements file.
+## Data Plotting
 
-## Launch the Clients
+Data has been plotted using the same Jupyter Notebook `report.ipynb`. The last page contains details about the plots. These plots are built from the CSV files downloaded previously with the same document.
 
-To launch the clients we have developed a repository to automatize running the clients using a docker-compose file. Please refer [here](https://github.com/migalabs/eth2-clients-setup) to discover more about it.
 
 
-## Data
 
-Data has been collected from Prometheus and from a Python script developed by us to double check the Prometheus data is correct.
-You may see the download script from Prometheus in the `download_data` folder.
-The Python project can be found [here](https://github.com/migalabs/eth2-client-analyzer).
-
-## Configuration Instructions
-
-The Execution command looks like the following:
-
-```
-python3 plot_data.py <config-file> csv-files
-
-Example:
-python3 plot_data.py configs/config_plot_NEvs_cpu.ini mainnet2/grandine_sample.csv mainnet2/NE_grandine.csv
-
-```
-Keep in mind that there are several different keywords we can give as metricType argument:
-- "mem" --> Outputs the Memory consumption plot
-- "cpu" --> Outputs the CPU consumption plot
-- "disk" --> Outputs the Disk Usage plot
-- "slot" --> Outputs the slot increase of each client across time
-- "peers" --> Outputs the number of peers plot
-- "netSent" --> Outputs the network sent bytes ratio plot
-- "netReceived" --> Outputs the network receive bytes ratio plot
-
-For the data_file argument, we may input the file we want to read the data from.
-
-
-Config file
-
-```
-[PLOT1]
-METRIC_NAME = disk (choose between disk, cpu, mem, slot, peers, netSent, netReceived)
-PLOT_TYPE = line (choose between line, scatter)
-SECOND_METRIC_NAME = (in case of sencond axis metric)
-SECOND_PLOT_TYPE = (choose between line, scatter)
-NUM_OF_POINTS = 100 (more points, more definition)
-MARKER = +,x,1,2,3,4
-MARKER_SIZE = 10
-INITIAL_DATE = 11/02/2022 14:21:32
-XAXIS = slot (what metric to use as xaxis)
-INTERVAL_SECS = 30 (interval between each xtick)
-START_X = 0 (in case of shifting the plot)
-MIN_Y_VALUE = 0 (adjust y axis)
-MAX_Y_VALUE = 120 (adjust y axis)
-MIN_SECOND_Y_VALUE = 0 (adjust y axis)
-MAX_SECOND_Y_VALUE = 100 (adjust y axis)
-CLIENT_ALLOWLIST = NE_Prysm, NE_Lighthouse, NE_Teku, NE_Nimbus, NE_Lodestar, NE_Grandine (clients to include in the plot)
-LEGEND_LOCATION = upper left
-STORE_PATH = figures/mainnet/disk/sync_grandine_NE
-```
-
-## Execution
-
-We have enabled a set of scripts that automatically execute the given plots with the data we collected a year ago. You may refer to the plot_scripts which automatically plot the data for the given csv files.
-We have also included the download script, which retrieves data from Prometheus and stores in a CSV file.
-This set of plots was used in May 2022 to perform the Resource Analysis V1. 
+Maintained by [MigaLabs](http://migalabs.io)