rapids/docs/setup/execution.md

36 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2020-11-04 19:27:58 +01:00
# Execution
After you have [installed](../installation) and [configured](../configuration) RAPIDS, use the following command to execute it.
2020-11-04 19:27:58 +01:00
```bash
./rapids -j1
```
!!! done "Ready to extract behavioral features"
If you are ready to extract features head over to the [Behavioral Features Introduction](../../features/feature-introduction/)
2021-02-21 23:30:30 +01:00
!!! hint "We wrap Snakemake"
2020-11-04 19:27:58 +01:00
The script `#!bash ./rapids` is a wrapper around Snakemake so you can pass any parameters that Snakemake accepts (e.g. `-j1`).
2020-11-04 22:41:39 +01:00
!!! hint "Updating RAPIDS output after modifying `config.yaml`"
2021-02-21 23:30:30 +01:00
Any changes to the `config.yaml` file will be applied automatically and only the relevant files will be updated. This means that after modifying the features list for `PHONE_MESSAGE` for example, RAPIDS will execute the script that computes `MESSAGES` features and update its output file.
2020-11-04 19:27:58 +01:00
!!! hint "Multi-core"
You can run RAPIDS over multiple cores by modifying the `-j` argument (e.g. use `-j8` to use 8 cores). **However**, take into account that this means multiple sensor datasets for different participants will be loaded in memory at the same time. If RAPIDS crashes because it ran out of memory, reduce the number of cores and try again.
2020-11-04 19:27:58 +01:00
2020-11-04 22:41:39 +01:00
As reference, we have run RAPIDS over 12 cores and 32 Gb of RAM without problems for a study with 200 participants with 14 days of low-frequency smartphone data (no accelerometer, gyroscope, or magnetometer).
2021-02-21 23:30:30 +01:00
!!! hint "Deleting RAPIDS output"
If you want to delete all the output files RAPIDS produces, you can execute the following command:
2020-11-04 22:41:39 +01:00
```bash
2021-02-21 23:30:30 +01:00
./rapids -j1 --delete-all-output
2020-11-04 22:41:39 +01:00
```
!!! hint "Forcing a complete rerun or updating your raw data in RAPIDS"
If you want to update your raw data or rerun the whole pipeline from scratch, run the following commands:
2020-11-04 22:41:39 +01:00
```bash
2020-12-03 00:41:03 +01:00
./rapids -j1 --delete-all-output
2021-02-21 23:30:30 +01:00
./rapids -j1
```