diff options
| author | diogo464 <[email protected]> | 2025-06-29 15:15:23 +0100 |
|---|---|---|
| committer | diogo464 <[email protected]> | 2025-06-29 15:15:23 +0100 |
| commit | 0509970c261d3c04822246c80e6f05dcd246b8a5 (patch) | |
| tree | 140a94eb4ad3f36636ff3f739f0c4c933650c229 /README.md | |
| parent | 5f81d08687494277ffe5f72b86d1c1b3c9341d9a (diff) | |
Rename project to oar-p2p-net
Update project name throughout all files: pyproject.toml, README.md, Justfile, and rename main Python file from oar_p2p.py to oar_p2p_net.py to maintain consistency with the new project name.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
| @@ -1,4 +1,4 @@ | |||
| 1 | # OAR P2P Network Management | 1 | # OAR P2P Net |
| 2 | 2 | ||
| 3 | A Python tool for managing P2P network configurations in OAR cluster environments with configurable latency matrices. | 3 | A Python tool for managing P2P network configurations in OAR cluster environments with configurable latency matrices. |
| 4 | 4 | ||
| @@ -11,7 +11,7 @@ This project uses [uv](https://docs.astral.sh/uv/) for dependency management. | |||
| 11 | curl -LsSf https://astral.sh/uv/install.sh | sh | 11 | curl -LsSf https://astral.sh/uv/install.sh | sh |
| 12 | 12 | ||
| 13 | # Run the tool directly | 13 | # Run the tool directly |
| 14 | uv run oar_p2p.py --help | 14 | uv run oar_p2p_net.py --help |
| 15 | ``` | 15 | ``` |
| 16 | 16 | ||
| 17 | ## Usage | 17 | ## Usage |
| @@ -21,19 +21,19 @@ The tool provides three main commands: | |||
| 21 | ### Setup Network (`up`) | 21 | ### Setup Network (`up`) |
| 22 | Configure network interfaces and apply latency settings: | 22 | Configure network interfaces and apply latency settings: |
| 23 | ```bash | 23 | ```bash |
| 24 | uv run oar_p2p.py up <job_id> <addresses> <latency_matrix_file> | 24 | uv run oar_p2p_net.py up <job_id> <addresses> <latency_matrix_file> |
| 25 | ``` | 25 | ``` |
| 26 | 26 | ||
| 27 | ### Cleanup Network (`down`) | 27 | ### Cleanup Network (`down`) |
| 28 | Remove network configurations: | 28 | Remove network configurations: |
| 29 | ```bash | 29 | ```bash |
| 30 | uv run oar_p2p.py down <job_id> | 30 | uv run oar_p2p_net.py down <job_id> |
| 31 | ``` | 31 | ``` |
| 32 | 32 | ||
| 33 | ### Generate Configurations (`configurations`) | 33 | ### Generate Configurations (`configurations`) |
| 34 | Preview the network configurations that would be applied: | 34 | Preview the network configurations that would be applied: |
| 35 | ```bash | 35 | ```bash |
| 36 | uv run oar_p2p.py configurations <job_id> <addresses> <latency_matrix_file> | 36 | uv run oar_p2p_net.py configurations <job_id> <addresses> <latency_matrix_file> |
| 37 | ``` | 37 | ``` |
| 38 | 38 | ||
| 39 | ## Requirements | 39 | ## Requirements |
