Skip to content

Commit ebb732b

Browse files
committed
remove old dependencies from README
1 parent 78dd6b8 commit ebb732b

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

crypto-benchmarks.rs/demo/README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,14 @@ This folder contains scripts that orchestrate end-to-end demonstrations of BLS-b
66

77
## Prerequisites
88

9-
- Build the CLI once from the repository root:
10-
11-
```bash
12-
cargo build --release -p crypto-benchmarks
13-
```
14-
15-
The resulting binary will be at:
16-
```
17-
target/release/leios_crypto_benchmarks
18-
```
19-
20-
- Ensure Python 3 is available with `cbor2` and `matplotlib` installed.
9+
- Ensure the CLI built from the repository root is available; see `crypto-benchmarks.rs/ReadMe.md` for build instructions and usage details.
10+
- Ensure Python 3 is available with `cbor2` installed.
2111
For example:
2212

2313
```bash
2414
python3 -m venv .venv
2515
source .venv/bin/activate
26-
pip install cbor2 matplotlib
16+
pip install cbor2
2717
```
2818

2919
## Workflow
@@ -32,54 +22,52 @@ The scripts are designed to be run from the `demo/` directory.
3222

3323
### Run Step by Step (Manual Mode)
3424

35-
You can run each script individually to understand and control each step of the process for a given number of voters (e.g., 32). Use the `-d` option to specify the output directory (e.g., `run32`).
36-
37-
RUN=run100
25+
You can run each script individually to understand and control each step of the process for a given number of voters (e.g., 100). Use the `-d` option to specify the output directory (e.g., `run100`).
3826

3927
#### 10_init_inputs.sh
4028

4129
Initialize inputs for N voters:
4230

4331
```bash
44-
scripts/10_init_inputs.sh -d "$RUN" --pools 500 --stake 100000 --alpha 9 --beta 1
32+
scripts/10_init_inputs.sh -d run100 --pools 500 --stake 100000 --alpha 9 --beta 1
4533
```
4634

4735
#### 20_make_registry.sh
4836

4937
Build the registry from initialized inputs:
5038

5139
```bash
52-
./scripts/20_make_registry.sh -d "$RUN" -n 100
40+
./scripts/20_make_registry.sh -d run100 -n 100
5341
```
5442

5543
#### 30_cast_votes.sh
5644

5745
Cast votes with a specified fraction of voters voting (e.g., 1.0 means all vote):
5846

5947
```bash
60-
scripts/30_cast_votes.sh -d "$RUN" -f 0.75
48+
scripts/30_cast_votes.sh -d run100 -f 0.75
6149
```
6250

6351
#### 40_make_certificate.sh
6452

6553
Generate the aggregated certificate:
6654

6755
```bash
68-
scripts/40_make_certificate.sh -d "$RUN"
56+
scripts/40_make_certificate.sh -d run100
6957
```
7058

7159
#### 50_verify_certificate.sh
7260

7361
Verify the generated certificate:
7462

7563
```bash
76-
scripts/50_verify_certificate.sh -d "$RUN"
64+
scripts/50_verify_certificate.sh -d run100
7765
```
7866

7967
### Run a Single End-to-End Demo
8068

8169
```bash
82-
scripts/70_run_one.sh -d "$RUN" -p 500 -n 100 -f 0.75
70+
scripts/70_run_one.sh -d run100 -p 500 -n 100 -f 0.75
8371
```
8472

8573
This will:
@@ -93,6 +81,16 @@ This will:
9381

9482
All files are placed in `demo/run100/`.
9583

84+
### Launch the Demo UI
85+
86+
After generating a demo run (for example via `scripts/70_run_one.sh`), start the UI server from this directory:
87+
88+
```bash
89+
python3 ui/server.py
90+
```
91+
92+
Then open your browser at [http://127.0.0.1:5050/ui](http://127.0.0.1:5050/ui) to explore the results.
93+
9694
## Notes
9795

9896
- All scripts must be run from within the `demo/` directory.

0 commit comments

Comments
 (0)