Environment setup

To work with nf-core pipelines, you will need to set up your computing environment with some essential tools. This section guides you through installing and configuring everything you need to get started.

What you’ll need

The core requirements for running nf-core pipelines are:

  1. Nextflow: The workflow management system that powers all nf-core pipelines
  2. Container or compute environment manager: A system to handle pipeline software (e.g., Docker, Singularity, or Conda)

These additional tools are recommended for development:

  1. nf-core tools: Command-line tools for working with nf-core pipelines (optional, but recommended)
  2. VS Code: A code editor with Nextflow extensions (optional, for pipeline development)

Getting started

If you are new to nf-core, we recommend following the guides in order:

  1. Install Nextflow
  2. Set up a Container or compute environment manager based on your system
  3. Install nf-core tools for additional utilities and pipeline management features
  4. Set up VS Code with the recommended extensions ff you plan to develop pipelines
Note

System requirements and installation methods vary depending on your operating system and whether you have administrator privileges. If you are uncertain, speak to your system administrator.