Skip to content

Add Conda install to install page #5892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 53 additions & 18 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,13 @@ To install Java with SDKMAN:

## Install Nextflow

Nextflow is distributed as a self-installing package, in order to make the installation process as simple as possible:
Nextflow is distributed as an easy to use self-installing package. It is also distributed via Conda and as a standalone distribution.

To install Nextflow:
### Self-install

In order to make the installation process as simple as possible, Nextflow is distributed as a self-installing package.

To install Nextflow with the self-installing package:

1. Download Nextflow:

Expand Down Expand Up @@ -89,37 +93,50 @@ To install Nextflow:
:::

:::{warning}
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.
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.
:::

4. Confirm that Nextflow is installed correctly:
4. Confirm Nextflow is installed correctly:

```{code-block} bash
:class: copyable
nextflow info
```

## Seqera Platform
### Conda

You can launch workflows directly from [Seqera Platform](https://seqera.io/platform/) without installing Nextflow locally.
To install Nextflow with Conda:

Launching from Seqera Platform provides you with:
1. Create an environment with Nextflow:

- User-friendly launch interfaces.
- Automated cloud infrastructure creation.
- Organizational user management.
- Advanced analytics with resource optimization.
```{code-block} bash
:class: copyable
conda create --name nf-env bioconda::nextflow
```

Seqera Cloud Basic is free for small teams. Researchers at qualifying academic institutions can apply for free access to Seqera Cloud Pro.
See the [Seqera Platform documentation](https://docs.seqera.io/platform) for set-up information and tutorials to get started.
2. Activate the environment:

(install-standalone)=
```{code-block} bash
:class: copyable
source activate nf_env
```

## Standalone distribution
3. Confirm Nextflow is installed correctly:

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.
```{code-block} bash
:class: copyable
nextflow info
```

The standalone distribution will still download core and third-party plugins as needed at runtime.
:::{warning}
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.
:::

(install-standalone)=

### Standalone distribution

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.

To use the standalone distribution:

Expand All @@ -136,5 +153,23 @@ To use the standalone distribution:

```{code-block} bash
:class: copyable
./nextflow-24.10.1-dist run hello
./nextflow-24.10.1-dist run info
```

:::{note}
The standalone distribution will still download core and third-party plugins as needed at runtime.
:::

## Seqera Platform

You can launch workflows directly from [Seqera Platform](https://seqera.io/platform/) without installing Nextflow locally.

Launching from Seqera Platform provides you with:

- User-friendly launch interfaces.
- Automated cloud infrastructure creation.
- Organizational user management.
- Advanced analytics with resource optimization.

Seqera Cloud Basic is free for small teams. Researchers at qualifying academic institutions can apply for free access to Seqera Cloud Pro.
See the [Seqera Platform documentation](https://docs.seqera.io/platform) for tutorials to get started.
Loading