Skip to content

Commit 75728bf

Browse files
committed
adding gen_archive optional parameter description
1 parent caea078 commit 75728bf

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/global_parameters.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,15 @@ Various parameters are related to the execution modes:
3434
- `offline`: When set to `true`, completely isolate the haddock3 run and results from internet. This option is useful when no internet connection is available. Default is `false`.
3535
- `debug`: By setting it to `false`, reduces the amount of I/O operations, often speeding up the process. When set to `true`, input files, intermediate files and output files are generated and kept, which is useful when tracking potential errors. The default is `false`.
3636

37-
### Local mode
37+
38+
#### Local mode
3839

3940
Often the prefered execution mode if you submit a haddock3 run to a queuing system or run on your own computer.
4041
The `local` mode (targeted using the global parameter `mode = 'local'`), utilize the operating system device to perform the computations.
4142
Setting the `ncores` parameter allows to tune the number of CPU cores to use during the run.
4243
Note that if you set this value too high compared to your system capabilities, this value will be automatically scaled down to the maximum number of cores available on the machine.
4344

44-
### Batch mode
45+
#### Batch mode
4546

4647
Utilise queuing system machinery to submit CNS runs.
4748

@@ -50,11 +51,12 @@ Utilise queuing system machinery to submit CNS runs.
5051
- `queue_limit`: Sets the number of jobs to submit to the batch system. Default is 100.
5152
- `concat`: Number of models to produce per job to send to the batch system. If set to a value above 1, multiple models can be calculated within one job. The default is 1.
5253

53-
### MPI mode
54+
#### MPI mode
5455

5556
Requires the installation of the `mpi4py` python library and `OpenMPI` to be installed on the operating system.
5657

5758
## Optional global parameters
5859

5960
- `postprocess`: When set to `true`, executes `haddock3-analyse` on the CAPRI folders at the end of the run. The default is `true`.
6061
- `preprocess`: When set to `true`, tries to correct input PDBs before the workflow. The default is `false`.
62+
- `gen_archive`: By setting it to `true`, at the end of the workflow, the entire `run_dir` will be compressed as a `.tgz` archive. In addition, the `analysis` directory will be archived too, and a local copy of models will be made in it. This allows to reduce the number of files to be transferred and make the analysis directory self-sufficient. Useful for the web application and if only the last models generated by the workflow are required. The default is `false`.

0 commit comments

Comments
 (0)