You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -221,7 +221,7 @@ process {
221
221
}
222
222
```
223
223
224
-
The above configuration snippet sets 2 cpus for every process labeled as `hello` and 4 cpus to every process *not*label as `hello`. It also specifies the `long` queue for every process whose name does *not* start with `align`.
224
+
The above configuration snippet sets 2 cpus for every process labeled as `hello` and 4 cpus to every process *not*labeled as `hello`. It also specifies the `long` queue for every process whose name does *not* start with `align`.
Copy file name to clipboardExpand all lines: docs/container.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ You will need Apptainer installed on your execution environment e.g. your comput
23
23
24
24
### Images
25
25
26
-
Apptainer makes use of a container image file, which physically contains the container. Refer to the [Apptainer documentation](https://apptainer.org/docs) to learn how create Apptainer images.
26
+
Apptainer makes use of a container image file, which physically contains the container. Refer to the [Apptainer documentation](https://apptainer.org/docs) to learn how to create Apptainer images.
27
27
28
28
Apptainer allows paths that do not currently exist within the container to be created and mounted dynamically by specifying them on the command line. However this feature is only supported on hosts that support the [Overlay file system](https://en.wikipedia.org/wiki/OverlayFS) and is not enabled by default.
29
29
@@ -41,10 +41,10 @@ The integration for Apptainer follows the same execution model implemented for D
41
41
nextflow run <your script> -with-apptainer [apptainer image file]
42
42
```
43
43
44
-
Every time your script launches a process execution, Nextflow will run it into a Apptainer container created by using the specified image. In practice Nextflow will automatically wrap your processes and launch them by running the `apptainer exec` command with the image you have provided.
44
+
Every time your script launches a process execution, Nextflow will run it into an Apptainer container created by using the specified image. In practice Nextflow will automatically wrap your processes and launch them by running the `apptainer exec` command with the image you have provided.
45
45
46
46
:::{note}
47
-
A Apptainer image can contain any tool or piece of software you may need to carry out a process execution. Moreover, the container is run in such a way that the process result files are created in the host file system, thus it behaves in a completely transparent manner without requiring extra steps or affecting the flow in your pipeline.
47
+
An Apptainer image can contain any tool or piece of software you may need to carry out a process execution. Moreover, the container is run in such a way that the process result files are created in the host file system, thus it behaves in a completely transparent manner without requiring extra steps or affecting the flow in your pipeline.
48
48
:::
49
49
50
50
If you want to avoid entering the Apptainer image as a command line parameter, you can define it in the Nextflow configuration file. For example you can add the following lines in the configuration file:
@@ -124,7 +124,7 @@ Nextflow caches Apptainer images in the `apptainer` directory, in the pipeline w
124
124
125
125
Nextflow uses the library directory to determine the location of Apptainer containers. The library directory can be defined using the `apptainer.libraryDir` configuration setting or the `NXF_APPTAINER_LIBRARYDIR` environment variable. The configuration file option overrides the environment variable if both are set.
126
126
127
-
Nextflow first checks the library directory when searching for the image. If the image is not found it then checks the cache directory. The main difference between the library directory and the cache directory is that the first is assumed to be a read-only container repository, while the latter is expected to be writable path where container images can added for caching purposes.
127
+
Nextflow first checks the library directory when searching for the image. If the image is not found it then checks the cache directory. The main difference between the library directory and the cache directory is that the first is assumed to be a read-only container repository, while the latter is expected to be writable path where container images can be added for caching purposes.
128
128
129
129
:::{warning}
130
130
When using a compute cluster, the Apptainer cache directory must reside in a shared filesystem accessible to all compute nodes.
@@ -573,7 +573,7 @@ In the above example replace `/path/to/singularity.img` with any Singularity ima
573
573
Read the {ref}`config-page` page to learn more about the configuration file and how to use it to configure your pipeline execution.
574
574
575
575
:::{note}
576
-
Unlike Docker, Nextflow does not automatically mount host paths in the container when using Singularity. It expects that the paths are configure and mounted system wide by the Singularity runtime. If your Singularity installation allows user defined bind points, read the {ref}`Singularity configuration <config-singularity>` section to learn how to enable Nextflow auto mounts.
576
+
Unlike Docker, Nextflow does not automatically mount host paths in the container when using Singularity. It expects that the paths are configured and mounted system wide by the Singularity runtime. If your Singularity installation allows user defined bind points, read the {ref}`Singularity configuration <config-singularity>` section to learn how to enable Nextflow auto mounts.
577
577
:::
578
578
579
579
:::{warning}
@@ -657,7 +657,7 @@ Nextflow caches Singularity images in the `singularity` directory, in the pipeli
657
657
658
658
Nextflow uses the library directory to determine the location of Singularity images. The library directory can be defined using the `singularity.libraryDir` configuration setting or the `NXF_SINGULARITY_LIBRARYDIR` environment variable. The configuration file option overrides the environment variable if both are set.
659
659
660
-
Nextflow first checks the library directory when searching for the image. If the image is not found it then checks the cache directory. The main difference between the library directory and the cache directory is that the first is assumed to be a read-only container repository, while the latter is expected to be writable path where container images can added for caching purposes.
660
+
Nextflow first checks the library directory when searching for the image. If the image is not found it then checks the cache directory. The main difference between the library directory and the cache directory is that the first is assumed to be a read-only container repository, while the latter is expected to be writable path where container images can be added for caching purposes.
661
661
662
662
:::{warning}
663
663
When using a compute cluster, the Singularity cache directory must reside in a shared filesystem accessible to all compute nodes.
Copy file name to clipboardExpand all lines: docs/developer-env.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Setting up a Nextflow development environment is a prerequisite for creating, te
9
9
- {ref}`devenv-vscode`: A versatile code editor that enhances your Nextflow development with features like syntax highlighting and debugging.
10
10
- {ref}`devenv-extensions`: The VS Code marketplace offers a variety of extensions to enhance development. The {ref}`Nextflow extension <devenv-nextflow>` is specifically designed to enhance Nextflow development with diagnostics, hover hints, code navigation, code completion, and more.
11
11
- {ref}`devenv-docker`: A containerization platform that ensures your Nextflow workflows run consistently across different environments by packaging dependencies into isolated containers.
12
-
- {ref}`devenv-git`: A version control system that helps manage and track changes in your Nextflow projects, making collaboration, and code management more efficient.
12
+
- {ref}`devenv-git`: A version control system that helps manage and track changes in your Nextflow projects, making collaboration and code management more efficient.
13
13
14
14
The sections below outline the steps for setting up these tools.
15
15
@@ -37,7 +37,7 @@ To install VS Code on Windows:
37
37
38
38
1. Visit the [VS Code](https://code.visualstudio.com/download) website.
39
39
1. Download VS Code for Windows.
40
-
1. Double-click the installer executable (`.exe`) file and follow the set up steps.
40
+
1. Double-click the installer executable (`.exe`) file and follow the setup steps.
Git provides powerful version control that helps track code changes. Git operates locally, meaning you don't need an internet connection to track changes, but it can also be used with remote platforms like GitHub, GitLab, or Bitbucket for collaborative development.
245
245
246
-
Nextflow seamlessly integrates with Git for source code management providers for managing pipelines as version-controlled Git repositories.
246
+
Nextflow seamlessly integrates with Git for source code management providers to manage pipelines as version-controlled Git repositories.
Copy file name to clipboardExpand all lines: docs/executor.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ The pipeline processes must specify the Docker image to use by defining the `con
18
18
19
19
To enable this executor, set `process.executor = 'awsbatch'` in the `nextflow.config` file.
20
20
21
-
The pipeline can be launched either in a local computer, or an EC2 instance. EC2 is suggested for heavy or long-running workloads. Additionally, an S3 bucket must be used as the pipeline work directory.
21
+
The pipeline can be launched either on a local computer, or an EC2 instance. EC2 is suggested for heavy or long-running workloads. Additionally, an S3 bucket must be used as the pipeline work directory.
22
22
23
23
Resource requests and other job characteristics can be controlled via the following process directives:
24
24
@@ -45,7 +45,7 @@ The pipeline processes must specify the Docker image to use by defining the `con
45
45
46
46
To enable this executor, set `process.executor = 'azurebatch'` in the `nextflow.config` file.
47
47
48
-
The pipeline can be launched either in a local computer, or a cloud virtual machine. The cloud VM is suggested for heavy or long-running workloads. Additionally, an Azure Blob storage container must be used as the pipeline work directory.
48
+
The pipeline can be launched either on a local computer, or a cloud virtual machine. The cloud VM is suggested for heavy or long-running workloads. Additionally, an Azure Blob storage container must be used as the pipeline work directory.
49
49
50
50
Resource requests and other job characteristics can be controlled via the following process directives:
51
51
@@ -121,7 +121,7 @@ By default, Flux will send all output to the `.command.log` file. To send this o
121
121
122
122
[Google Cloud Batch](https://cloud.google.com/batch) is a managed computing service that allows the execution of containerized workloads in the Google Cloud Platform infrastructure.
123
123
124
-
Nextflow provides built-in support for the Cloud Batch API, which allows the seamless deployment of a Nextflow pipeline in the cloud, offloading the process executions as pipelines.
124
+
Nextflow provides built-in support for the Cloud Batch API, which allows the seamless deployment of Nextflow pipelines in the cloud, offloading the pipeline process executions.
125
125
126
126
The pipeline processes must specify the Docker image to use by defining the `container` directive, either in the pipeline script or the `nextflow.config` file. Additionally, the pipeline work directory must be located in a Google Storage bucket.
127
127
@@ -299,7 +299,7 @@ Resource requests and other job characteristics can be controlled via the follow
299
299
300
300
## NQSII
301
301
302
-
The `nsqii` executor allows you to run your pipeline script using the [NQSII](https://www.rz.uni-kiel.de/en/our-portfolio/hiperf/nec-linux-cluster) resource manager.
302
+
The `nqsii` executor allows you to run your pipeline script using the [NQSII](https://www.rz.uni-kiel.de/en/our-portfolio/hiperf/nec-linux-cluster) resource manager.
303
303
304
304
Nextflow manages each process as a separate job that is submitted to the cluster using the `qsub` command provided by the scheduler.
Copy file name to clipboardExpand all lines: docs/git.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
## Git configuration
6
6
7
-
The file `$HOME/.nextflow/scm` allows you to centralise the security credentials required to access private project repositories on Bitbucket, GitHub and GitLab source code management (SCM) platforms or to manage the configuration properties of private server installations (of the same platforms).
7
+
The file `$HOME/.nextflow/scm` allows you to centralize the security credentials required to access private project repositories on Bitbucket, GitHub and GitLab source code management (SCM) platforms or to manage the configuration properties of private server installations (of the same platforms).
8
8
9
9
The configuration properties for each Git provider are defined inside the `providers` section. Properties for the same provider are grouped with a common name and delimited with curly brackets. For example:
10
10
@@ -74,7 +74,7 @@ App passwords are substitute passwords for a user account which you can use for
74
74
BitBucket Server uses a different API from the [BitBucket](https://bitbucket.org/) Cloud service. Make sure to use the right configuration whether you are using the cloud service or a self-hosted installation.
75
75
:::
76
76
77
-
To access your local BitBucket Server create an entry in the [SCM configuration file](#git-configuration)specifying as shown below:
77
+
To access your local BitBucket Server create an entry in the [SCM configuration file](#git-configuration) as shown below:
78
78
79
79
```groovy
80
80
providers {
@@ -146,7 +146,7 @@ See [Gitea documentation](https://docs.gitea.io/en-us/api-usage/) about how to e
146
146
147
147
### Azure Repos
148
148
149
-
Nextflow has builtin support for [Azure Repos](https://azure.microsoft.com/en-us/services/devops/repos/), a Git source code management service hosted in the Azure cloud. To access your Azure Repos with Nextflow provide the repository credentials using the configuration snippet shown below:
149
+
Nextflow has built-in support for [Azure Repos](https://azure.microsoft.com/en-us/services/devops/repos/), a Git source code management service hosted in the Azure cloud. To access your Azure Repos with Nextflow provide the repository credentials using the configuration snippet shown below:
150
150
151
151
```groovy
152
152
providers {
@@ -194,7 +194,7 @@ Then the pipeline can be accessed with Nextflow as shown below:
194
194
nextflow run https://git-codecommit.eu-west-1.amazonaws.com/v1/repos/my-repo
195
195
```
196
196
197
-
In the above example replace `my-repo` with your own repository. Note also that AWS CodeCommit has different URLs depending the region in which you are working.
197
+
In the above example replace `my-repo` with your own repository. Note also that AWS CodeCommit has different URLs depending on the region in which you are working.
198
198
199
199
:::{note}
200
200
The support for protocols other than HTTPS is not available at this time.
0 commit comments