Skip to content

Commit ebb6047

Browse files
committed
Minor doc edits
1 parent b805b18 commit ebb6047

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

consensus_decentralization/analyze.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ def analyze(projects, aggregated_data_filename, input_dir, output_dir, populatio
1616
Calculates all available metrics for the given ledgers and timeframes. Outputs one file for each metric.
1717
:param projects: list of strings that correspond to the ledgers whose data should be analyzed
1818
:param aggregated_data_filename: string that corresponds to the name of the file that contains the aggregated data
19+
:param input_dir: the directory where the aggregated data is located
20+
:param output_dir: the directory to save the results in
21+
:param population_windows: the number of windows to look backwards and forwards to determine the population of
22+
active block producers for a given time period
1923
:returns: a list with the names of all the metrics that were used
2024
2125
Using multiple projects and timeframes is necessary here to produce collective csv files.

docs/aggregator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Aggregator
22

3-
The aggregator obtains the mapped data of a ledger (from `processed_data/<project_name>/mapped_data.json`) and
4-
aggregates it over units of time that are determined based on the given `timeframe` and `aggregate_by` parameters.
3+
The aggregator obtains the mapped data of a ledger (from `processed_data/<project_name>/mapped_data_<(non_)clustered>.json`)
4+
and aggregates it over units of time that are determined based on the given `timeframe` and `aggregate_by` parameters.
55
It then outputs a `csv` file with the distribution of blocks to entities for each time unit under consideration.
66
This file is saved in the directory `processed_data/<project name>/blocks_per_entity/` and is named based on the
77
`timeframe` and `aggregate_by` parameters.

0 commit comments

Comments
 (0)