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/install.md
+53-18Lines changed: 53 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -54,9 +54,13 @@ To install Java with SDKMAN:
54
54
55
55
## Install Nextflow
56
56
57
-
Nextflow is distributed as a self-installing package, in order to make the installation process as simple as possible:
57
+
Nextflow is distributed as an easy to use self-installing package. It is also distributed via Conda and as a standalone distribution.
58
58
59
-
To install Nextflow:
59
+
### Self-install
60
+
61
+
In order to make the installation process as simple as possible, Nextflow is distributed as a self-installing package.
62
+
63
+
To install Nextflow with the self-installing package:
60
64
61
65
1. Download Nextflow:
62
66
@@ -89,37 +93,50 @@ To install Nextflow:
89
93
:::
90
94
91
95
:::{warning}
92
-
Nextflow will update its executable during the self update process, therefore the update can fail if the executable is placed in a directory with restricted permissions.
96
+
Nextflow updates its executable during the self-install process, therefore the update can fail if the executable is placed in a directory with restricted permissions.
93
97
:::
94
98
95
-
4. Confirm that Nextflow is installed correctly:
99
+
4. Confirm Nextflow is installed correctly:
96
100
97
101
```{code-block} bash
98
102
:class: copyable
99
103
nextflow info
100
104
```
101
105
102
-
## Seqera Platform
106
+
### Conda
103
107
104
-
You can launch workflows directly from [Seqera Platform](https://seqera.io/platform/) without installing Nextflow locally.
108
+
To install Nextflow with Conda:
105
109
106
-
Launching from Seqera Platform provides you with:
110
+
1. Create an environment with Nextflow:
107
111
108
-
- User-friendly launch interfaces.
109
-
- Automated cloud infrastructure creation.
110
-
- Organizational user management.
111
-
- Advanced analytics with resource optimization.
112
+
```{code-block} bash
113
+
:class: copyable
114
+
conda create --name nf-env bioconda::nextflow
115
+
```
112
116
113
-
Seqera Cloud Basic is free for small teams. Researchers at qualifying academic institutions can apply for free access to Seqera Cloud Pro.
114
-
See the [Seqera Platform documentation](https://docs.seqera.io/platform) for set-up information and tutorials to get started.
117
+
2. Activate the environment:
115
118
116
-
(install-standalone)=
119
+
```{code-block} bash
120
+
:class: copyable
121
+
source activate nf_env
122
+
```
117
123
118
-
## Standalone distribution
124
+
3. Confirm Nextflow is installed correctly:
119
125
120
-
The Nextflow standalone distribution (i.e. the `dist` release) is a self-contained `nextflow` executable that can run without needing to download core dependencies at runtime. This distribution is useful for offline environments, as well as building and testing Nextflow locally.
126
+
```{code-block} bash
127
+
:class: copyable
128
+
nextflow info
129
+
```
121
130
122
-
The standalone distribution will still download core and third-party plugins as needed at runtime.
131
+
:::{warning}
132
+
Installing Nextflow via Conda may lead to outdated versions, dependency conflicts, and Java compatibility issues. Using the self-installing package is recommended for a more reliable and up-to-date installation.
133
+
:::
134
+
135
+
(install-standalone)=
136
+
137
+
### Standalone distribution
138
+
139
+
The Nextflow standalone distribution (i.e., the `dist` release) is a self-contained `nextflow` executable that can run without needing to download core dependencies at runtime. This distribution is useful for offline environments as well as building and testing Nextflow locally.
123
140
124
141
To use the standalone distribution:
125
142
@@ -136,5 +153,23 @@ To use the standalone distribution:
136
153
137
154
```{code-block} bash
138
155
:class: copyable
139
-
./nextflow-24.10.1-dist run hello
156
+
./nextflow-24.10.1-dist run info
140
157
```
158
+
159
+
:::{note}
160
+
The standalone distribution will still download core and third-party plugins as needed at runtime.
161
+
:::
162
+
163
+
## Seqera Platform
164
+
165
+
You can launch workflows directly from [Seqera Platform](https://seqera.io/platform/) without installing Nextflow locally.
166
+
167
+
Launching from Seqera Platform provides you with:
168
+
169
+
- User-friendly launch interfaces.
170
+
- Automated cloud infrastructure creation.
171
+
- Organizational user management.
172
+
- Advanced analytics with resource optimization.
173
+
174
+
Seqera Cloud Basic is free for small teams. Researchers at qualifying academic institutions can apply for free access to Seqera Cloud Pro.
175
+
See the [Seqera Platform documentation](https://docs.seqera.io/platform) for tutorials to get started.
0 commit comments