• Home
  • Pipelines
  • Resources
    • Components
    • Modules
    • Subworkflows

    • Configs
    • Shared configs

    • Plugins & Actions
    • nft-utils
    • setup-nextflow
    • setup-nf-test
  • Docs
  • Community
    • What's happening
    • Advisories
    • Blog

    • Events
    • Bytesize Talks
    • Hackathons
    • Training
    • Talks
    • Weekly Helpdesks

    • Programs and groups
    • Special interest groups
    • In-progress RFCs
    • Mentorships
    • Contributors
    • Shop new
    • Connect game 👾
  • About
    • About nf-core
    • Stickers
    • Governance
    • Marketing
    • Code of conduct

    • Publications
    • Statistics

    • Join nf-core
    • Select theme
    • Light
    • Dark
    • System
    • Select theme
    • Light
    • Dark
    • System
    Join nf-core Join nf-core

nf-core documentation

Learn to use nf-core pipelines, develop workflows, and contribute to the community

Get started

New to nf-core? Start here to learn the basics and run your first pipeline.

What is nf-core?

Introduction to the nf-core project and community

Environment setup

Set up your system to run nf-core pipelines

Run your first pipeline

Step-by-step guide to running an nf-core pipeline

Topics

Explore documentation by topic to find what you need.

Running

Run and configure nf-core pipelines

Developing

Create and maintain nf-core pipelines, components, and configs

Contributing

Contribute to the nf-core community

Specifications

Technical specifications for nf-core pipelines, components, and test data

Community

Community resources and guidelines

nf-core/tools

Command-line tools and API for working with nf-core

Additional resources

Learn Nextflow and nf-core through comprehensive documentation and hands-on training materials.

Nextflow documentation

Official Nextflow language documentation and guides

Nextflow and nf-core training

Hands-on training materials and workshops

  • Get started
    • What is nf-core?
    • Environment setup
      • Overview
      • Nextflow
      • Software dependencies
      • nf-core tools
      • VS Code
      • Dev Containers
    • Run your first pipeline
  • Running
    • Overview
    • Advanced topics
      • Google Colab
      • Managing work directory growth
    • Configuration
      • Overview
      • System requirements
    • Reference genomes
    • Running pipelines offline
  • Developing
    • Overview
    • Components
      • Automated methods
      • Create components
      • Cross organisational components
      • ext arguments
      • Meta maps
      • Setting custom remotes
    • Containers
      • ARM64 on Bioconda
      • Seqera Containers
    • Documentation
      • Code formatting
      • Harshil alignment
      • Markdown
      • Style guide
      • Topic types
    • Institutional profiles
      • Overview
      • Configuration
      • Documentation
      • File structure
      • nf-core/configs outside nf-core
      • Preparing to write
      • Testing
    • Migration guides
      • Migrating to topic channels
    • Pipelines
      • Adding modules
      • External use
      • Renaming branches
      • Template files
    • Template syncs
      • Overview
      • Fixing a broken TEMPLATE branch
      • Manually syncing your pipeline
      • Merging automated PRs
      • Setting up a pipeline sync retrospectively
    • Testing
      • Overview
      • Advanced
      • Assertions
  • Contributing
    • Overview
    • Components
    • Contribution types
    • Contributor's list
    • Deprecating modules
    • Documentation
    • Existing pipelines
    • New pipelines
    • Project proposals
    • Reviewing pull requests
      • nf-core bot
      • Review checklists
        • Components
        • nf-core/tools
        • Pipelines
      • Reviewing pipeline releases
  • Specifications
    • Overview
    • Components
      • Overview
      • Modules
        • General
        • Naming conventions
        • Input/output Options
        • Documentation
        • Parameters
        • Resource requirements
        • Software
        • Testing
        • Misc
      • Subworkflows
        • General
        • Naming conventions
        • Input output options
        • Subworkflow parameters
        • Documentation
        • Testing
        • Misc
    • Pipelines
      • Overview
      • Recommendations
        • Publication credit
        • Testing
        • Bioconda
        • Build with community
        • Cloud compatible
        • Custom containers
        • DOIs
        • File formats
      • Requirements
        • Acknowledgements
        • CI testing
        • Community owned
        • Docker
        • Docs
        • Git branches
        • Identity branding
        • Keywords
        • Linting
        • Minimum inputs
        • MIT license
        • Nextflow
        • Parameters
        • RO Crate
        • Semantic versioning
        • Single command
        • Use the template
        • Workflow name
        • Workflow size
        • Workflow specificity
    • Reviews
      • Overview
      • Request reviewers
      • Rapid merge
      • Review scope
      • Commit strategy
    • Test data
      • Overview
      • General
      • Modules
  • Community
    • Advisories
    • Brand
      • Overview
      • Colours
      • Fonts
      • Logos
      • Presentations
      • Workflow schematics
    • Governance
      • Core team tasks
      • Maintainers tasks
    • Regulatory
      • Overview
      • Checklist
    • Terminology
  • nf-core/tools
    • API
    • CLI
      • Installation
      • Pipelines
        • create
        • list
        • launch
        • create params file
        • download
        • licences
        • rocrate
        • lint
        • schema
        • bump version
        • sync
        • create logo
      • Modules
        • list
        • info
        • install
        • update
        • remove
        • patch
        • create
        • lint
        • test
        • bump versions
      • Subworkflows
        • list
        • info
        • install
        • update
        • remove
        • create
        • lint
        • test
      • Test datasets
        • list
        • list branches
        • search
      • TUI
Making awesome workflows since 2018.

Supported by:

+ + +
See the source code for this website on GitHub:
https://github.com/nf-core/website