Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
youngjoon-lee committed Jul 15, 2024
1 parent 6ffc313 commit ae28697
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions mixnet/sim/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# NomMix Simulation

* [Features](#features)
* [Future Plans](#future-plans)
* [Installation](#installation)
* [Getting Started](#getting-started)

## Features

- Simulate the NomMix protocol with the given parameters.
- Measure the performance of the NomMix protocol (Bandwidth usages, for now).
- Measure the performance of the NomMix protocol.
- Bandwidth usages
- Analyze the privacy properties that the NomMix protocol provides.
- Message sizes
- Node states and hamming distances

## Future Plans

- Simulate more features of the NomMix protocol.
- Temporal mixing
- Level-1 noise
- Simulate possible adversarial attacks and measure the robustness of the NomMix protocol.

## Installation

Clone the repository and install the dependencies:
Expand All @@ -19,7 +32,7 @@ source .venv/bin/activate
pip install -r requirements.txt
```

## Getting started
## Getting Started

Copy the [`mixnet/sim/config.ci.yaml`](./config.ci.yaml) file and adjust the parameters to your needs.
Each parameter is explained in the config file.
Expand Down

0 comments on commit ae28697

Please sign in to comment.