Skip to content

Commit

Permalink
Merge pull request #1 from wineslab/update-readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
mychele authored Jan 29, 2025
2 parents 8f7f6e3 + 3b57886 commit 304942e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# spear-dApp
# dApp Library

password of the colosseum container of dApp is `spear`
A complete tutorial on how to deploy a dApp can be found on the [OpenRAN Gym website](https://openrangym.com/tutorials/dapps-oai). Please refer to that guide to instrument your system.

## Usage

Expand All @@ -11,7 +11,7 @@ password of the colosseum container of dApp is `spear`

### System configuration for OTA

This part of the guide is inteded to be only if running with `--ota` thus with UDS sockets
This part of the guide is inteded to be only if running with `--ota` thus with Unix Domain Sockets (UDSs).
If we need the dApp to run in a different user than OAI (e.g., $USER vs root) we need to create a specific unix users group called `dapp` and we assign root and user to this group to enable shared UDS through a dedicated foldert:
```
sudo groupadd dapp
Expand Down Expand Up @@ -49,7 +49,9 @@ OAI should start _before_ running the dApp
python3 src/dapp/dapp.py
```

There are many possible arguments:
This dApp implements a spectrum sharing use case discussed in [our paper](https://arxiv.org/pdf/2501.16502).

The dApp can be controlled through the following command-line arguments:
- `ota` bool (false): If true, use the OAI and spectrum configurations for OTA else use the ones of Colosseum
- `control` bool (false): If set to true, performs the PRB masking
- `energy-gui` bool (false): If set to true, creates and show the energy spectrum
Expand Down

0 comments on commit 304942e

Please sign in to comment.