Deployed 0a4821d with MkDocs version: 1.6.0

Author: github-actions[bot]

contribute/index.html

@@ -125,6 +125,14 @@ <h3 id="mapping-information">Mapping information</h3>
 <p>To contribute mapping information you can either update an existing file, by
 changing and/or adding some entries, or create a new file for a newly-supported
 ledger.</p>
+<p>Note: If you add an entry in <code>mapping_addresses</code> with a source that does not
+already exist, you should also add this source in the file
+<code>mapping_information/sources.json</code>. Specifically, if it comes from a
+publicly-available website you should add it under "Explorers", otherwise either
+use an existing appropriate keyword or create a new one. If you create a new
+one, make sure to also include it in the configuration file <code>config.yaml</code> and in
+the description of the <a href="https://blockchain-technology-lab.github.io/tokenomics-decentralization/setup/">Setup
+page</a>).</p>
 <h3 id="price-information">Price information</h3>
 <p>The directory <code>price_data/</code> contains information about the supported ledgers'
 market price. Each file in this folder is named <code>&lt;project_name&gt;.csv</code> (for the

index.html

@@ -169,5 +169,5 @@ <h2 id="contributing">Contributing</h2>
 
 <!--
 MkDocs version : 1.6.0
-Build Date UTC : 2024-07-01 09:35:30.786252+00:00
+Build Date UTC : 2024-07-16 14:13:52.641802+00:00
 -->

search/search_index.json

@@ -115,23 +115,19 @@ <h2 id="execution">Execution</h2>
 <p><code>ledgers</code> defines the ledgers that will be analyzed. By default, all supported
 ledgers are included here (to add support for a new ledger see the <a href="https://blockchain-technology-lab.github.io/tokenomics-decentralization/contribute/">conributions
 page</a>).</p>
-<p><code>execution_flags</code> defines various flags that control the data handling (all set to false by default):</p>
+<p><code>execution_flags</code> defines flags that control the data handling (all set to false by default):</p>
 <ul>
-<li><code>force_map_addresses</code>: if set to true, the address helper data from the directory
+<li><code>force_map_addresses</code>: if set to true, the address mapping data from the directory
   <code>mapping_information</code> is re-computed; you should set this flag to true if the
-  data has been updated since the last execution for the given ledger</li>
-<li><code>force_map_balances</code>: is set to true, the balance data of the ledger's addresses is
-  recomputed; you should set this flag to true if the data has been updated
-  since the last execution for the given ledger</li>
-<li><code>force_analyze</code>: if set to true, the computation of a metric is recomputed; you should set
-  this flag to true if any type of data has been updated since the last
-  execution for the given ledger</li>
+  mapping data has been updated since the last execution for the given ledger</li>
 </ul>
 <p><code>analyze_flags</code> defines various analysis-related flags:</p>
 <ul>
-<li><code>clustering</code>: a boolean that determines whether addresses will be clustered into entities
- (as defined in the mapping information). If set to false, no clustering takes
-  place and the addresses are treated as distinct entities.</li>
+<li><code>clustering_sources</code>: a list of sources that should be used to compute the
+  address mapping information. If empty, no clustering takes place and the
+  addresses are treated as distinct entities. The list should contain any
+  combination of the following options (<em>case sensitive</em>): "Explorers", "Staking
+  Keys", "Multi-input transactions".</li>
 <li><code>top_limit_type</code>: a string that can take one of two values (<code>absolute</code> or <code>percentage</code>) that
   enables applying a threshold on the addresses that will be considered</li>
 <li><code>top_limit_value</code>: the value of the top limit that should be applied; if 0,
@@ -163,10 +159,8 @@ <h2 id="execution">Execution</h2>
 contain raw address balance information, as obtained from BigQuery or a full
 node (for more information about this see the <a href="https://blockchain-technology-lab.github.io/tokenomics-decentralization/data/">data collection
 page</a>).
-<code>output_directories</code> defines the directories to store the databases which
-contain the mapping information and analyzed data. The first entry in the output
-directories is also used to store the output files of the analysis and the
-plots.</p>
+<code>output_directories</code> defines the directory to store the output files of the
+analysis and the plots.</p>
 <p>Finally, <code>plot_parameters</code> contains various parameters that control whether plots will be produced for the results and for which configurations.</p>
 
             </div>