Update docs

Author: LadyChristina

README.md

@@ -58,8 +58,8 @@ analyzed. If only the timeframe is specified, all ledgers will be analyzed for
 the given timeframe. If no arguments are given, all ledgers will be analyzed for
 all months since January 2018.
 
-Three files `nc.csv`, `gini.csv`, `entropy.csv` are also created in the `output` directory, containing the data from the 
-last execution of `run.py`.
+Three files `nc.csv`, `gini.csv`, `entropy.csv` are also created in the `results` directory, containing the data from 
+the last execution of `run.py`.
 
 ## Contributing
 

docs/setup.md

@@ -28,41 +28,39 @@ in the `raw_block_data/` directory, each file named as `<project_name>_raw_data.
 By default,
 there is a (very small) sample input file for some supported projects; to use it, remove the prefix `sample_`.
 
-Run `python run.py --ledgers <ledger_1> <ledger_n> --timeframe <timeframe> --estimation-window <days to aggregate 
-blocks by> --frequency <days between two data points>` to analyze the n specified ledgers for the given timeframe, 
-aggregated using the given estimation window and frequency.
-All arguments are optional, so it's possible to omit any of them; in this case, the default values
-will be used. Specifically:
-
-- `ledgers` accepts any number of the supported ledgers (case-insensitive). For example, `--ledgers bitcoin` 
-  would run the analysis for Bitcoin, while `--ledgers Bitcoin Ethereum Cardano` would run the analysis for Bitcoin, 
-  Ethereum and Cardano. If the `ledgers` argument is omitted, then the analysis is performed for the ledgers 
-  specified in the `config.yaml` file, which are typically all supported ledgers.
-- The `timeframe` argument accepts one or two values of the form `YYYY-MM-DD` (month and day can be
-  omitted), which indicate the beginning and end of the time period that will be analyzed. For example, 
-  `--timeframe 2022` would run the analysis for the year 2022 (so from January 1st 2022 to 
-  December 31st 2022), while we could also get the same result using `--timeframe 2022-01 2022-12` or 
-  `--timeframe 2022-01-01 2022-12-31`. Similarly, `--timeframe 2022-02` or `--timeframe 2022-02-01 2022-02-28` would 
-  do it for the month of February 2022 (February 1st 2022 to February 28th 2022), while `--timeframe 2022-02-03` 
-  would do it for a single day (Feburary 3rd 2022). Last, `--timeframe 2018 2022` would run the analysis for the 
-  entire time period between January 1st 2018 and December 31st 2022. If the `timeframe` argument is omitted, then 
-  the start date and end dates of the time frame are sourced from the `config.yaml` file.
-- `estimation_window` corresponds to the number of days that will be used to aggregate the data. For example, 
-  `--estimation_window 7` means that every data point will use 7 days of blocks to calculate the distribution of 
-  blocks to entities. If left empty, then the entire time frame will be used (only valid when combined with empty frequency).
-  - `frequency` determines how frequently to sample the data, in days. If left empty, then only one data point will be 
-  analyzed (snapshot instead of longitudinal analysis), but this is only valid when combined with an empty estimation_window.
-
-Additionally, there are three flags that can be used to customize an execution:
-
-- `--force-map` forces the parsing, mapping and aggregation to be performed on all data, even if the relevant output
-  files already exist. This can be useful for when mapping info is updated for some blockchain. By default, this flag is
-  set to False and the tool only performs the mapping and aggregation when the relevant output files do not exist.
-- `--plot` enables the generation of graphs at the end of the execution. Specifically, the output of each 
+Run `python run.py` to run the analysis with the parameters specified in the `config.yaml` file.
+
+The parameters that can be specified in the `config.yaml` file are:
+
+- `metrics`: a list with the metrics that will be calculated. By default, includes all implemented metrics.
+- `ledgers`: a list with the ledgers that will be analyzed. By default, includes all supported ledgers.
+- `force-map`: a flag that can force the parsing, mapping and aggregation to be performed on all data, even if the
+  relevant output files already exist. This can be useful for when mapping info is updated for some blockchain. By
+  default, this flag is set to False and the tool only performs the mapping and aggregation when the relevant output
+  files do not exist.
+- `clustering`: a flag that specifies whether block producers will be clustered based on the available mapping 
+  information. By default, this flag is set to True.
+- `start_date`: a value of the form `YYYY-MM-DD` (month and day can be omitted), which indicates the beginning of the
+  time period that will be analyzed. 
+- `end_date`: a value of the form `YYYY-MM-DD` (month and day can be omitted), which indicates the end of the time
+  period that will be analyzed.
+- `estimation_window`: the number of days that will be used to aggregate the data. For example,
+  `estimation_window 7` means that every data point will use 7 days of blocks to calculate the distribution of
+  blocks to entities. If left empty, then the entire time frame will be used (only valid when combined with empty
+  frequency).
+- `frequency`: number of days that determines how frequently to sample the data. If left empty, then only one data
+  point will be analyzed (snapshot instead of longitudinal analysis), but this is only valid when combined with an 
+  empty estimation_window.
+- `population_windows`: number that defines the number of windows to look back and forward when calculating the
+  population of block producers. For example, `population_windows 3`, combined with `estimation_window 7` means that the 
+  population of block producers will be calculated using the blocks produced in the 3 weeks before and after each 
+  week under consideration. If `all` is specified, then the entire time frame will be used to determine the population.
+- `plot`: a flag that enables the generation of graphs at the end of the execution. Specifically, the output of each 
 implemented metric is plotted for the specified ledgers and timeframe, as well as the block production dynamics for each
 specified ledger. By default, this flag is set to False and no plots are generated.
-- `--animated` enables the generation of (additional) animated graphs at the end of the execution. By default, this flag
-is set to False and no animated plots are generated. Note that this flag is ignored if `--plot` is set to False.
+- `animated`: a flag that enables the generation of (additional) animated graphs at the end of the execution. By 
+  default, this flag is set to False and no animated plots are generated. Note that this flag is ignored if `plot` is
+  set to False.
 
 
 All output files can then be found under the `results/` directory, which is automatically created the first time the