GuilloteauQ/study-docker-repro-longevity
1
0
Fork 0
Code Issues 6 Pull Requests Actions Projects Releases Wiki Activity

Added doc for running the Snakemake workflow.

Browse Source
This commit is contained in:
antux18 2024-08-15 12:32:39 +02:00
parent 0bbed9d0f5
commit 744b3b0d35
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -58,7 +58,14 @@ Otherwise, you can use the Nix package manager and run `nix develop` in this dir
### Running the whole workflow ### Running the whole workflow
*TODO: write the doc* First, open `config/config.yaml` and change `system` to `local` if you try to run the workflow outside of the Grid'5000 testbed.
Then, run the following command at the root directory of the repository:
```
snakemake --cores <nb_cores>
```
Where `<nb_cores>` is the number of cores you want to assign to the workflow. The number of cores determine the number of instances of ECG that can run in parallel, so you may want to assign as many cores as possible here.
### Running each component separately ### Running each component separately
@ -145,7 +152,7 @@ Where:
- `<input_table1>`, `<input_table2>`... are one or more output tables from ECG. The required ECG output depends on the analysis script, see below. - `<input_table1>`, `<input_table2>`... are one or more output tables from ECG. The required ECG output depends on the analysis script, see below.
- `<output_table>` is the path where to store the table generated by the analysis script. - `<output_table>` is the path where to store the table generated by the analysis script.
*TODO: explain outputs* *TODO: explain the content of the output files*
##### Software environment analysis ##### Software environment analysis