LogoLogo
Illumina KnowledgeIllumina SupportSign In
  • Home
  • Overview
    • Illumina® DRAGEN™ Secondary Analysis
    • DRAGEN Applications
    • Deployment Options
  • Product Guides
    • DRAGEN v4.4
      • Getting Started
      • DRAGEN Host Software
        • DRAGEN Secondary Analysis
      • Clinical Research Workflows
        • Common Product Features
          • Sample Sheets
          • Run Planning
            • Sample Sheet Creation in BaseSpace
            • Custom Config Support
          • DRAGEN Server App
            • Advanced Topics
              • Data Management
              • Illumina Connected Insights Local
          • ICA Cloud App
            • Variant Interpretation with Illumina Connected Insights
        • DRAGEN Heme WGS Tumor Only Pipeline
          • Quick Start
            • Sample Sheet Requirements
              • Templates
          • DRAGEN Server App
            • Launching Analysis
              • Command Line Options
              • Local Specific Output
            • Advanced Topics
              • Custom Config Support
          • ICA Cloud App
            • Launching Analysis
              • ICA Specific Output
            • Advanced Topics
              • Custom Workflow
              • Custom Config Support
              • Post Processing
          • Analysis Output
          • Analysis Methods
          • Troubleshooting
        • DRAGEN Solid WGS Tumor Normal Pipeline
          • Quick Start
            • Sample Sheet Requirements
              • Templates
          • DRAGEN Server App
            • Launching Analysis
              • Command Line Options
              • Local Specific Output
            • Advanced Topics
              • Custom Config Support
          • ICA Cloud App
            • Launching Analysis
            • Advanced Topics
              • Custom Workflow
              • Custom Config Support
              • Post Processing
          • Analysis Output
          • Analysis Methods
          • Troubleshooting
      • DRAGEN Recipes
        • DNA Germline Panel UMI
        • DNA Germline Panel
        • DNA Germline WES UMI
        • DNA Germline WES
        • DNA Germline WGS UMI
        • DNA Germline WGS
        • DNA Somatic Tumor-Normal Solid Panel UMI
        • DNA Somatic Tumor-Normal Solid Panel
        • DNA Somatic Tumor-Normal Solid WES UMI
        • DNA Somatic Tumor-Normal Solid WES
        • DNA Somatic Tumor-Normal Solid WGS UMI
        • DNA Somatic Tumor-Normal Solid WGS
        • DNA Somatic Tumor-Only Heme WGS
        • DNA Somatic Tumor-Only Solid Panel UMI
        • DNA Somatic Tumor-Only Solid Panel
        • DNA Somatic Tumor-Only Solid WES UMI
        • DNA Somatic Tumor-Only Solid WES
        • DNA Somatic Tumor-Only Solid WGS UMI
        • DNA Somatic Tumor-Only Solid WGS
        • DNA Somatic Tumor-Only ctDNA Panel UMI
        • Illumina scRNA
        • Other scRNA prep
        • RNA Panel
        • RNA WTS
      • DRAGEN Reference Support
        • Prepare a Reference Genome
      • DRAGEN DNA Pipeline
        • DNA Mapping
        • Read Trimming
        • DRAGEN FASTQC
        • Sorting and Duplicate Marking
        • Small Variant Calling
          • ROH Caller
          • B-Allele Frequency Output
          • Somatic Mode
          • Pedigree Analysis
          • De Novo Small Variant Filtering
          • Autogenerated MD5SUM for VCF Files
          • Force Genotyping
          • Machine Learning for Variant Calling
          • Evidence BAM
          • Mosaic Detection
          • VCF Imputation
          • Multi-Region Joint Detection
        • Copy Number Variant Calling
          • Available pipelines
            • Germline CNV Calling (WGS/WES)
            • Germline CNV Calling ASCN (WGS)
            • Multisample Germline CNV Calling
            • Somatic CNV Calling ASCN (WGS)
            • Somatic CNV Calling WES
            • Somatic CNV Calling ASCN (WES)
          • Additional documentation
            • CNV Input
            • CNV Preprocessing
            • CNV Segmentation
            • CNV Output
            • CNV ASCN module
            • CNV with SV Support
            • Cytogenetics Modality
        • Repeat Expansion Detection
          • De Novo Repeat Expansion Detection
        • Targeted Caller
          • CYPDB6 Caller
          • CYP2D6 Caller
          • CYP21A2 Caller
          • GBA Caller
          • HBA Caller
          • LPA Caller
          • Rh Caller
          • SMN Caller
        • Structural Variant Calling
          • Structural Variant De Novo Quality Scoring
          • Structural Variant IGV Tutorial
        • VNTR Calling
        • Population Genotyping
        • Filter Duplicate Variants
        • Ploidy Calling
          • Ploidy Estimator
          • Ploidy Caller
        • Multi Caller
        • QC Metrics Reporting
        • JSON Metrics Reporting
        • HLA Typing
        • Biomarkers
          • Tumor Mutational Burden
          • Microsatellite Instability
          • Homologous Recombination Deficiency
          • BRCA Large Genomic Rearrangment
          • DRAGEN Fragmentomics
        • Downsampling
          • Fractional (Raw Reads) Downsampling
        • Unique Molecular Identifiers
        • Indel Re-aligner (Beta)
        • Star Allele Caller
        • High Coverage Analysis
        • CheckFingerprint
        • Population Haplotyping (Beta)
        • DUX4 Rearrangement Caller
      • DRAGEN RNA Pipeline
        • RNA Alignment
        • Gene Fusion Detection
        • Gene Expression Quantification
        • RNA Variant Calling
        • Splice Variant Caller
      • DRAGEN Single Cell Pipeline
        • Illumina PIPseq scRNA
        • Other scRNA Prep
        • scATAC
        • Single-Cell Multiomics
      • DRAGEN Methylation Pipeline
      • DRAGEN MRD Pipeline
      • DRAGEN Amplicon Pipeline
      • Explify Analysis Pipeline
        • Kmer Classifier
        • Kmer Classifier Database Builder
      • BCL conversion
      • Illumina Connected Annotations
      • ORA Compression
      • Command Line Options
        • Docker Requirements
      • DRAGEN Reports
      • Tools and Utilities
    • DRAGEN v4.3
      • Getting Started
      • DRAGEN Host Software
        • DRAGEN Secondary Analysis
      • DRAGEN Reference Support
        • Prepare a Reference Genome
      • DRAGEN DNA Pipeline
        • DNA Mapping
        • Read Trimming
        • DRAGEN FASTQC
        • Sorting and Duplicate Marking
        • Small Variant Calling
          • ROH Caller
          • B-Allele Frequency Output
          • Somatic Mode
          • Joint Analysis
          • De Novo Small Variant Filtering
          • Autogenerated MD5SUM for VCF Files
          • Force Genotyping
          • Machine Learning for Variant Calling
          • Evidence BAM
          • Mosaic Detection
          • VCF Imputation
          • Multi-Region Joint Detection
        • Copy Number Variant Calling
          • CNV Output
          • CNV with SV Support
          • Multisample CNV Calling
          • Somatic CNV Calling WGS
          • Somatic CNV Calling WES
          • Allele Specific CNV for Somatic WES CNV
        • Repeat Expansion Detection
          • De Novo Repeat Expansion Detection
        • Targeted Caller
          • CYPDB6 Caller
          • CYP2D6 Caller
          • CYP21A2 Caller
          • GBA Caller
          • HBA Caller
          • LPA Caller
          • Rh Caller
          • SMN Caller
        • Structural Variant Calling
          • Structural Variant De Novo Quality Scoring
        • VNTR Calling
        • Filter Duplicate Variants
        • Ploidy Calling
          • Ploidy Estimator
          • Ploidy Caller
        • Multi Caller
        • QC Metrics Reporting
        • HLA Typing
        • Biomarkers
          • Tumor Mutational Burden
          • Microsatellite Instability
          • Homologous Recombination Deficiency
          • BRCA Large Genomic Rearrangment
          • DRAGEN Fragmentomics
        • Downsampling
          • Fractional (Raw Reads) Downsampling
          • Effective Coverage Downsampling
        • Unique Molecular Identifiers
        • Indel Re-aligner (Beta)
        • Star Allele Caller
        • High Coverage Analysis
        • CheckFingerprint
        • Population Haplotyping (Beta)
        • DUX4 Rearrangement Caller
      • DRAGEN RNA Pipeline
        • RNA Alignment
        • Gene Fusion Detection
        • Gene Expression Quantification
        • RNA Variant Calling
        • Splice Variant Caller
      • DRAGEN Single-Cell Pipeline
        • scRNA
        • scATAC
        • Single-Cell Multiomics
      • DRAGEN Methylation Pipeline
      • DRAGEN Amplicon Pipeline
      • Explify Analysis Pipeline
        • Kmer Classifier
        • Kmer Classifier Database Builder
      • DRAGEN Recipes
        • DNA Germline Panel UMI
        • DNA Germline Panel
        • DNA Germline WES UMI
        • DNA Germline WES
        • DNA Germline WGS UMI
        • DNA Germline WGS
        • DNA Somatic Tumor-Normal Solid Panel UMI
        • DNA Somatic Tumor-Normal Solid Panel
        • DNA Somatic Tumor-Normal Solid WES UMI
        • DNA Somatic Tumor-Normal Solid WES
        • DNA Somatic Tumor-Normal Solid WGS UMI
        • DNA Somatic Tumor-Normal Solid WGS
        • DNA Somatic Tumor-Only Heme WGS
        • DNA Somatic Tumor-Only Solid Panel UMI
        • DNA Somatic Tumor-Only Solid Panel
        • DNA Somatic Tumor-Only Solid WES UMI
        • DNA Somatic Tumor-Only Solid WES
        • DNA Somatic Tumor-Only Solid WGS UMI
        • DNA Somatic Tumor-Only Solid WGS
        • DNA Somatic Tumor-Only ctDNA Panel UMI
        • RNA Panel
        • RNA WTS
      • BCL conversion
      • Illumina Connected Annotations
      • ORA Compression
      • Command Line Options
      • DRAGEN Reports
      • Tools and Utilities
  • Reference
    • DRAGEN Server
    • DRAGEN Application Manager
    • DRAGEN Multi-Cloud
      • DRAGEN on AWS
      • DRAGEN on AWS Batch
      • DRAGEN on Microsoft Azure
        • Run DRAGEN VM on Azure
      • DRAGEN on Microsoft Azure Batch
        • Azure Batch Run Modes
    • DRAGEN Licensing
      • DRAGEN Server Licensing
      • DRAGEN Cloud Licensing
    • Support
    • Resource Files
      • Noise Baselines
    • Supplementary Information
    • Troubleshooting
    • Citing DRAGEN software
    • Release Notes
    • Revision History
Powered by GitBook
On this page
  • Installation Procedure on DRAGEN Server
  • Downloader
  • Expected downloaded content
  • Installer
  • Uninstall pipeline

Was this helpful?

Export as PDF
  1. Product Guides
  2. DRAGEN v4.4
  3. Clinical Research Workflows
  4. DRAGEN Solid WGS Tumor Normal Pipeline

DRAGEN Server App

PreviousTemplatesNextLaunching Analysis

Last updated 2 days ago

Was this helpful?

Installation Procedure on DRAGEN Server

Downloader

A separate lightweight downloader for Windows, macOS, and Linux operating systems is available at the .

Choose the downloader appropriate for your platform, when executed it will prompt you to provide a path to download the assets to. The required software packages will be downloaded into the dragen_pipelines directory under the path provided at the prompt. If the path provided was used for a previous execution of the downloader, any incomplete downloads will be resumed, existing files will be checksummed, and any files with invalid checksums will be re-downloaded.

The downloaded directory content may be moved to the installation target DRAGEN server using a USB key with at least 128 GB of free space or by copying to Network Storage which is reachable from the target DRAGEN Server.

Additional download information is available at the download site.

Downloader System Requirements

Downloader Name
System Requirements

Solid_WGS_TN_{version}_Downloader_unix

x86_64 platform with glibc 2.25+

Solid_WGS_TN_{version}_Downloader_mac

arm64 macOS

Solid_WGS_TN_{version}_Downloader_windows.exe

64-bit Windows 10+

Expected downloaded content

  • dragen_pipelines

    • dragen-app-manager-1.0.14-1.x86_64-el8-offline.run

    • README

    • Solid_WGS_TN_4.4.4.53

      • install_Solid_WGS_TN_v4.4.4.53.run

      • Solid_WGS_TN_4.4.4.53.iapp

      • README

    • common

      • solid-wgs-tn-resources_4.4.4.2.ires

      • dpf-core_1.0.0.36.ires

      • dpf-templates_4.4.4.52.ires

      • dpf-docker-images_4.4.4.52.ires

      • dragen-4.4.4-12.multi.el8.x86_64.run

      • hg38-alt_masked.cnv.graph.hla.methyl_cg.rna-11-r5.0-1.ires

      • hg38-alt_masked.cnv.hla.methyl_cg.methylated_combined.rna-11-r5.0-1.ires

      • hs37d5_chr-cnv.graph.hla.methyl_cg.rna-11-r5.0-1.ires

      • hs37d5_chr-cnv.hla.methyl_cg.methylated_combined.rna-11-r5.0-1.ires

      • variant_annotation_data-tmb_annotations-4.4.4-1.ires

Installer

Installation Requirements

DRAGEN and DRAGEN Application Manager

The pipeline requires DRAGEN v4.4.4 or higher. If upon installation of the app this version of DRAGEN (or higher) is not installed, the software shall install this version of DRAGEN.

Minimum System Operating Requirements

Hardware

  • v3 DRAGEN server or v4 DRAGEN server

  • mkfifo is enabled on the network-attached storage (NAS).

Software

The software installed by default on the DRAGEN server includes the following items:

  • DRAGEN server software. Refer to sample sheet settings for the DRAGEN version number.

  • Oracle Linux 8

Storage

  • DRAGEN server v3 provides a 6.4 TB NVMe SSD. This SSD is located at the /staging directory and is suitable for storing only one or two runs of the analysis pipeline.

  • DRAGEN server v4 provides 12.8 TB via a 2 x 6.4 TB NVMe U.2 SSD configuration.

  • Consider the following when making data storage decisions.

    • A NovaSeq 6000 sequencing run that uses an S4 flow cell can produce up to 3 TB of output. ▫ The pipeline can produce an additional 4-6 TB of analysis output. For optimal performance when writing to a non-default directory, specify an analysis folder location on /staging, this ensures that the DRAGEN-related processes read and write data to the DRAGEN Server's high-speed NVMe SSD.

    • Network-attached storage is required for long-term storage of sequencing runs and pipeline output.

    • Managing data storage is your responsibility.

      • Illumina recommends developing a strategy to copy data from the DRAGEN server to network-attached storage.

Installation Instructions

  • Installing the pipeline requires root privileges.

    • Follow the instructions for DRAGEN license installation provided by Illumina Customer Care or refer to the DRAGEN server documentation.

  • Copy the directory structure from the downloader directory to the target DRAGEN server (or a path accessible with sudo privileges)

  • Ensure the installer has the correct privileges by running chmod +x install_Solid_WGS_TN_v{version}.run

  • Launch the installer with root privileges sudo /path/to/install_Solid_WGS_TN_v{version}.run

    • If DRAGEN Application Manager is not already installed, the installer will exit and direct you to the path to the DRAGEN Application Manager installer

Run Self-Test Script

The self-test script, present after app installation, checks the following functions:

  • All required services are running.

  • All resources are in place.

  • The analysis workflow image can be launched.

  • The pipeline can run successfully on a test dataset.

To run the self-test script, execute:

/usr/local/bin/check_Solid_WGS_TN_{version}.sh

If the self-test prints a failure message, contact Illumina Technical Support, and provide the output file found in /staging/check_Solid_WGS_TN_{version}_{datetimestamp}.tgz.

When running an analysis on the DRAGEN server via SSH, Illumina recommends that you use a terminal multiplexer utility, which allows you to resume analysis in the event of a disconnection from the DRAGEN server.

Uninstall pipeline

To uninstall the pipeline, run the following command as the root user (or with sudo privileges):

/usr/local/bin/uninstall_Solid_WGS_TN_{version}..sh

Executing the uninstall script removes the following assets:

  • All scripts, including:

    • run_Solid_WGS_TN_{version}.sh

    • check_Solid_WGS_TN_{version}.sh

    • uninstall_Solid_WGS_TN_{version}.sh

    • The application installed under DRAGEN Application Manager

If the uninstall script is executed with the -r or --removeResources flag, dependencies of the application being uninstalled will be removed if no other applications depend on them.

You are not required to uninstall DRAGEN Application Manager, Docker, or the DRAGEN server software.

To remove Docker, review the install instructions for your operating system in the Docker documentation

The pipeline also requires DRAGEN Application Manager to be installed, and an installer is included. DRAGEN Application Manager configuration is controlled by the config.toml file located in /etc/dragen-app-manager directory. See for additional information.

Delete output data on the DRAGEN server as soon as possible. For additional information on data output and storage, refer to .

Contact Illumina Customer Care to request a link to the Downloader or visit and confirm that the Genome DRAGEN license is enabled for your server.

📂
📂
📂
DRAGEN Installer Download Site
DRAGEN Resource Files
DRAGEN Application Manager
Illumina Instrument Control Computer Security and Networking
DRAGEN Installer Download Site