codex-storage
/
das-research
mirror of https://github.com/codex-storage/das-research.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve readme 

Signed-off-by: Csaba Kiraly <csaba.kiraly@gmail.com>
This commit is contained in:
Csaba Kiraly 2024-03-29 16:35:20 +01:00
parent 36d098cea3
commit c53043bab9
No known key found for this signature in database
GPG Key ID: 0FE274EE8C95166E
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -12,7 +12,26 @@ erasure coded block from the block builder to validators. The simulator tracks d
network and validation progress. It is highly configurable, and it allows to explore the parameter
space in one run, generating also summary figures.
## Prepare the environment
### Talks
Results from the simulator were featured in the following talks:
* EthereumZuri.ch 2023 - Csaba Kiraly - Data Availability Sampling from the Networking Perspective,
[see on YouTube](https://www.youtube.com/watch?v=M-xkP4FzYMQ)
* EDCON 2023 - Leonardo Bautista-Gomez - Understanding Design Choices in Data Availability Sampling
[see on YouTube](https://www.youtube.com/watch?v=N1e_LDrKxZg)
* EthPrague 2023 - Leonardo Bautista-Gomez - Understanding Design Choices in Data Availability Sampling
[see on YouTube](https://www.youtube.com/watch?v=Al7Jns8bCO4)
* EthCC 2023 - Csaba Kiraly - Understanding Design Choices in Data Availability Sampling
[see on YouTube](https://www.youtube.com/watch?v=pUAVEbzLHLk)
### Versions
For recent improvements, see the [develop branch](https://github.com/codex-storage/das-research/tree/develop)
## Usage
### Prepare the environment
* Clone the DAS repository (if not done yet) and go into the das-research directory
@ -29,12 +48,17 @@ source myenv/bin/activate
pip3 install -r DAS/requirements.txt
```
## Run the simulator
### Run the simulator
The simulation requires a configuration written in Python. To run a small example, use the `smallConf.py` configuration file:
```
python3 study.py smallConf.py
```
Results with plots will be saved in the `results` folder.
See the same example `smallConf.py` file for the description of configuration options. To derive your own simulations, copy the file, customize, and run.
## License
Licensed and distributed under either of