From ae286976b1438b69caec62be450e438e2d37eb1e Mon Sep 17 00:00:00 2001 From: Youngjoon Lee <5462944+youngjoon-lee@users.noreply.github.com> Date: Tue, 16 Jul 2024 00:03:06 +0900 Subject: [PATCH] update readme --- mixnet/sim/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/mixnet/sim/README.md b/mixnet/sim/README.md index 7de60bb..8600862 100644 --- a/mixnet/sim/README.md +++ b/mixnet/sim/README.md @@ -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: @@ -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.