Skip to content

Commit 83b2c29

Browse files
christopher-hakkaartpditommasojustinegeffen
authored
Add Conda install to install page (#5892) [ci skip]
Signed-off-by: Paolo Di Tommaso <[email protected]> Signed-off-by: Christopher Hakkaart <[email protected]> Signed-off-by: Chris Hakkaart <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Justine Geffen <[email protected]>
1 parent 06e0d42 commit 83b2c29

File tree

1 file changed

+53
-18
lines changed

1 file changed

+53
-18
lines changed

docs/install.md

Lines changed: 53 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,13 @@ To install Java with SDKMAN:
5454
5555
## Install Nextflow
5656
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.
5858
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:
6064
6165
1. Download Nextflow:
6266
@@ -89,37 +93,50 @@ To install Nextflow:
8993
:::
9094
9195
:::{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.
9397
:::
9498
95-
4. Confirm that Nextflow is installed correctly:
99+
4. Confirm Nextflow is installed correctly:
96100
97101
```{code-block} bash
98102
:class: copyable
99103
nextflow info
100104
```
101105
102-
## Seqera Platform
106+
### Conda
103107
104-
You can launch workflows directly from [Seqera Platform](https://seqera.io/platform/) without installing Nextflow locally.
108+
To install Nextflow with Conda:
105109
106-
Launching from Seqera Platform provides you with:
110+
1. Create an environment with Nextflow:
107111
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+
```
112116
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:
115118
116-
(install-standalone)=
119+
```{code-block} bash
120+
:class: copyable
121+
source activate nf_env
122+
```
117123
118-
## Standalone distribution
124+
3. Confirm Nextflow is installed correctly:
119125
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+
```
121130
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.
123140
124141
To use the standalone distribution:
125142
@@ -136,5 +153,23 @@ To use the standalone distribution:
136153
137154
```{code-block} bash
138155
:class: copyable
139-
./nextflow-24.10.1-dist run hello
156+
./nextflow-24.10.1-dist run info
140157
```
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

Comments
 (0)