Skip to content

Commit 8a3b4db

Browse files
committed
[scripts] Comment to explain script usage
1 parent 5e159da commit 8a3b4db

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

scripts/runBenchmarks_script.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
11
#!/usr/bin/env python3
2+
"""
3+
Run SOFA benchmarks from a JSON config file.
4+
5+
Usage:
6+
python runBenchmarks_script.py -config benchmarks.json
7+
python runBenchmarks_script.py -config benchmarks.json -output results/my_run
8+
9+
Change the SOFA executable:
10+
python runBenchmarks_script.py -config benchmarks.json -sofa_exe /path/to/runSofa
11+
12+
Load SofaPython3:
13+
python runBenchmarks_script.py -config benchmarks.json -python
14+
15+
Override Parameters:
16+
python runBenchmarks_script.py -config benchmarks.json -n_tests 5 -warmup 2 -iterations 1000 -timeout 60
17+
18+
Required config keys: iterations, n_tests, timeout, cases
19+
Optional config keys: sofa_exe (default: runSofa), warmup (default: 1), output (default: log.benchmark)
20+
CLI flags override the corresponding config-file values.
21+
"""
222
import os
323
import re
424
import sys

0 commit comments

Comments
 (0)