Skip to content

Commit a6efa74

Browse files
committed
Update basic_usage.rst
1 parent 796629e commit a6efa74

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/user/basic_usage.rst

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -180,31 +180,29 @@ To use LMAS the following options are available:
180180
(default 3d)
181181
182182
183-
LMAS configuration files
184-
^^^^^^^^^^^^^^^^^^^^^^^^^
183+
Using the configuration files
184+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
185185
186-
There are four configuration files in LMAS:
186+
There are four configuration files in LMAS. Besides `nextflow.config`, which is in the main folder of the project,
187+
all others are located in the `conf` folder.
187188
188-
nextflow.config
189-
^^^^^^^^^^^^^^^
189+
- **nextflow.config**
190190
191191
This is Nextflow main configuration file.
192192
The resource parameters are available here, and can be changed directly here.
193193
194194
.. warning:: The **memory** and **cpu** directives increment automatically when a task is retried. If the directive is set to ``{16.Gb*task.attempt}``, the memory used will be 16 Gb multiplied by the number of attempts. By default LMAS is set to run a maximum of 2 retires per process. If the maximum resources are reached before the maximum number of tries, these won't be incremented beyond the defined limit.
195195
196-
params.config
197-
^^^^^^^^^^^^^
196+
- **params.config**
198197
199198
The ``params.config`` file includes all available parameters for LMAS and their respective default values.
200199
201-
containers.config
202-
^^^^^^^^^^^^^^^^^
200+
- **containers.config**
203201
204202
The ``containers.config`` file includes the container directive for each process in LMAS.
205203
These containers are retrieved from **dockerhub** if they do not exist locally yet.
206204
207-
.. warning:: You can change the container string to any other value, but it should point to an image that exists on dockerhub or locally.
205+
.. warning:: You can change the container string to any other value, but it should point to an nextflow-compatible container that exists on a repository, like `DockerHub <https://hub.docker.com/>`_ or `Quay <>`_, or locally.
208206
209207
profiles.config
210208
^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)