Merge pull request #2 from Blockchain-Technology-Lab/main

[CHORE] ⬆ IUpdate Fork

Author: MokhFn

README.md

@@ -14,6 +14,7 @@ Currently, the supported blockchains are:
 - Litecoin
 - Tezos
 - Zcash
+
 We intend to add more ledgers to this list in the future.
 
 ## Installation
@@ -23,9 +24,9 @@ To install the tool, simply clone this project:
     git clone https://github.com/Blockchain-Technology-Lab/consensus-decentralization.git
 
 The [requirements file](requirements.txt) lists the dependencies of the project.
-Make sure you have all of them installed before running the scripts. To install
-all of them in one go, run the following command from the root directory of the
-project:
+Make sure you have all of them installed (preferably within a [`virtualenv`](https://docs.python.org/3/library/venv.html)) 
+before running the scripts. To install all of them in one go, 
+run the following command from the root directory of the project:
 
     python -m pip install -r requirements.txt
 

docs/parsers.md

@@ -36,6 +36,6 @@ The field `identifiers` corresponds to:
 - `Tezos`: there is no such field
 
 If using BigQuery, the queries for Bitcoin, Bitcoin Cash, Dogecoin, Litecoin, Zcash (see [Data Collection](data.md))
-return data that are parsed with the `default_parser` script in `parsers`.
-The query for Cardano returns data that is parsed using the `cardano_parser` script in `parsers`.
+return data that are parsed with the `default_parser` module in `parsers`.
+The query for Ethereum returns data that is parsed using the `ethereum_parser` module in `parsers`.
 All other queries return data already in the necessary parsed form, so they are parsed using a "dummy" parser.

docs/setup.md

@@ -42,6 +42,7 @@ argument is omitted, then a monthly analysis is performed for each month between
 or the subset of this time period for which relevant data exists.
 
 Additionally, there are four flags that can be used to customize an execution:
+
 - `--force-parse` forces the re-parsing of all raw data files, even if the corresponding parsed data files already
 exist. This can be useful for when raw data gets updated for some blockchain. By default, this flag is set to False and 
 the tool only parses blockchain data for which no parsed data file exists.
@@ -51,7 +52,7 @@ and the tool only performs the mapping when the relevant mapped data files do no
 - `--plot` 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
+- `--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.
 
 

requirements.txt

@@ -3,7 +3,7 @@ pytest>=6.2.5
 coverage==7.1.0
 flake8==6.0.0
 google-cloud-bigquery~=3.7.0
-PyYAML~=5.4
+PyYAML>=5.4
 matplotlib>=3.4.3
 seaborn>=0.11.2
 colorcet>=3.0.1