Skip to content

Commit c87b6e8

Browse files
committed
add some wording
1 parent 661abb8 commit c87b6e8

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

INSTRUCTIONS.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Expected output: `Loaded image: mjqm-simulator:latest`.
2626
Apple Silicon/ARM machines run the image transparently via
2727
Docker Desktop's Rosetta emulation.
2828

29+
An alternative is to build the image natively from the source code that we also provide in the `src` directory. We explain this on the last section at the end of this README. This option requires more time than loading the image directly from the tarball
30+
2931
## Quick check (Phase I)
3032

3133
Run the bundled example script to verify the simulator works correctly:
@@ -71,7 +73,16 @@ docker run --rm \
7173
./simulator tools_oneOrT
7274
```
7375

74-
Results are written to the `Results/` directory on the host.
76+
Results are written to the `Results/` directory on the host.
77+
78+
Simulations can also run with a cap on the CPU usage with the options `--cpus=n` to help reduce the workload if running on a personal machine. For example this command will run on only 2 cores (a quarter of an 8-core machine presumably):
79+
80+
```sh
81+
docker run --rm --cpus=2 \
82+
-v "$(pwd)/Results:/app/Results" \
83+
mjqm-simulator \
84+
./simulator tools_five_bpar
85+
```
7586

7687
### Reproducing the paper figures
7788

@@ -86,7 +97,7 @@ The following configurations reproduce the figures in the paper:
8697

8798
### Runtime estimates
8899

89-
<span style="color:red">IMPORTANT</span>
100+
<span style="color:red">[IMPORTANT] It is strongly recommended to not only use the options to limit the CPU usage, but also to run on reduced number of events for the bigger configurations (as explained below), in order to not put a lot of pressure especially if the artifact is running on a personal machine.</span>
90101

91102
Configurations based on the Google Borg Cell B dataset (`tools_B_*`)
92103
require a large number of events (30–60 million) to produce reliable

0 commit comments

Comments
 (0)