aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordiogo464 <[email protected]>2025-07-10 22:36:26 +0100
committerdiogo464 <[email protected]>2025-07-10 22:36:26 +0100
commit1fd86a1c3990f8cec85294ce77152ec4762ae397 (patch)
tree4393d3b051cf97dc6a0ad62b842b85efb115cf0f /README.md
parent571879fde25147e471c7fed99677fc4b8429c1a4 (diff)
removed README.md, will re-add later
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 0 insertions, 48 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 671b4fb..0000000
--- a/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
1# OAR P2P Net
2
3A Python tool for managing P2P network configurations in OAR cluster environments with configurable latency matrices.
4
5## Installation
6
7This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
8
9```bash
10# Install uv if you haven't already
11curl -LsSf https://astral.sh/uv/install.sh | sh
12
13# Run the tool directly
14uv run oar_p2p_net.py --help
15```
16
17## Usage
18
19The tool provides three main commands:
20
21### Setup Network (`up`)
22Configure network interfaces and apply latency settings:
23```bash
24uv run oar_p2p_net.py up --job-id <job_id> --num-addresses <addresses> --latency-matrix <latency_matrix_file>
25```
26
27### Cleanup Network (`down`)
28Remove network configurations:
29```bash
30uv run oar_p2p_net.py down --job-id <job_id>
31```
32
33### Generate Configurations (`configurations`)
34Preview the network configurations that would be applied:
35```bash
36uv run oar_p2p_net.py configurations --job-id <job_id> --num-addresses <addresses> --latency-matrix <latency_matrix_file>
37```
38
39## Requirements
40
41- Python 3.12+
42- Access to OAR cluster environment
43- Docker with networking privileges
44- Custom networking container: `ghcr.io/diogo464/oar-p2p-networking:latest`
45
46## License
47
48MIT \ No newline at end of file