Skip to content

Commit af369a8

Browse files
committed
Add usage
1 parent c7ed54d commit af369a8

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,19 @@ pip install -r requirements.txt
6464

6565
### Usage
6666

67-
...
67+
For the dynamic task allocation, run:
68+
```python
69+
import gcaa
70+
gcaa.optimal_control_dta(
71+
nt=4, # number of tasks
72+
na=5, # number of agents
73+
uniform_agents=False, # whether agents have an initial speed
74+
n_rounds=100, # number of simulation rounds (precision vs compute time)
75+
limited_communication=True, # whether communication is limited (True, False, or 'both')
76+
)
77+
```
78+
79+
The sensitivity analysis of the parameters isn't available in Python.
6880

6981
### Tests
7082

gcaa/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
from gcaa.algorithms.greedy import GCAA
2+
from gcaa.core.dta import optimal_control_dta

0 commit comments

Comments
 (0)