> For the complete documentation index, see [llms.txt](https://help.connected.illumina.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.connected.illumina.com/dragen-stratamap/dragen-spatial-transcriptome/getting-started/dragen-app-manager-local/installation.md).

# Installation

### Overview

This section describes how to install the DRAGEN Spatial Transcriptome Local App on a v4 DRAGEN server.

### Step 1: Download and transfer to the DRAGEN Server

1. The app installation package is made available by Illumina Support via a pre-signed URL upon request.
2. Download the file from the URL using your preferred method.
   1. If a network connection is available on the DRAGEN Server, download the file directly to the server using the following command: `sudo wget <URL>`
3. If downloaded to a separate device, transfer to the server one of the following ways:
   1. Transfer from a mounted network drive:
      1. Copy the installation package to a mounted network drive available to the DRAGEN Server.
      2. Copy the installation package to the `/staging/` directory from the network drive.\
         `rsync /mounted-location-of-network-drive/<installation-package> /staging/`
   2. Transfer via USB (general instructions):
      1. Obtain a Linux-compatible formatted USB drive and copy the installation package to it.\
         Mount the USB drive on the DRAGEN server.
         1. Copy the installation package from the USB's mount point to the `/staging/` directory.
         2. Safely unmount the USB drive from the server after the transfer is complete.
4. Check the permissions on the files downloaded, it may be necessary to give them execute permissions\
   `chmod +x app_installer.run`

Note: If you are not familiar with mounting USB devices or moving files to restricted directories, work with your organization's IT team. They can help ensure the installation package is safely transferred to the DRAGEN server.

### Step 2: Install the Application

1. Navigate to the installation package within the `/staging/` directory:\
   `cd /staging/<installation-package>/`
2. Extract the contents of the `tar.gz` archive containing the installation files:\
   `tar -xzvf <installation-package>.tar.gz`
3. (Optional) Run the following command to install DRAGEN Application Manager 1.1.7 if it is not installed or is an incorrect version:\
   `sudo ./install_DAM_v1.1.7.run`

   Follow all prompts; refer to the provided DRAGEN Application Manager user guide for questions.
4. Run the following command to install the application:\
   `sudo ./install_DRAGEN_Spatial_Transcriptome.sh`
5. After successful installation, run the self-test:\
   `sudo ./run_self_test.sh`

This script automatically installs:

```
Application package (.iapp) - The main analysis pipeline
Genome resources (.ires) - Reference genomes (hg38 and mm39)
Image resources (.ires) - Supporting image processing files
```

{% hint style="info" %}
Installation time: the full installation typically takes 15–30 minutes depending on system performance.
{% endhint %}

#### Installation Options

These are advanced options for modified installations and reinstallations.

| Option               | Description                            |
| -------------------- | -------------------------------------- |
| `--iapp-path PATH`   | Specify a custom application file path |
| `--genome-path PATH` | Specify a custom genome resource path  |
| `--image-path PATH`  | Specify a custom image resource path   |
| `--skip-resources`   | Skip all resource installation         |
| `--skip-genomes`     | Skip genome resource installation only |
| `--skip-images`      | Skip image resource installation only  |
| `--help`             | Display help information               |

Example: install the application only (skip resources):

`./install_DRAGEN_Spatial_Transcriptome.sh --skip-resources`

#### Verifying the Installation

After installation, verify that all components are properly installed.

Check installed applications and resources:

`dragen-app-manager list | jq`

Example output:

```json
{
  "Applications": [
    {
      "Name": "DRAGEN_Spatial_Transcriptome",
      "Version": "2.0.0",
      "Provider": "Illumina",
      "Dependencies": {
        "Resources": [
          {
            "Name": "DRAGEN_Spatial_Transcriptome_hg38_mm39_Dragen11",
            "Version": "2.0.0",
            "Provider": "Illumina"
          },
          {
            "Name": "DRAGEN_Spatial_Transcriptome_Images",
            "Version": "2.0.0",
            "Provider": "Illumina"
          }
        ],
        "Images": []
      },
      "Type": "NEXTFLOW_DRAGEN"
    }
  ],
  "Resources": [
    {
      "Name": "DRAGEN_Spatial_Transcriptome_Images",
      "Version": "2.0.0",
      "Provider": "Illumina",
      "Type": "IMAGE"
    },
    {
      "Name": "DRAGEN_Spatial_Transcriptome_hg38_mm39_Dragen11",
      "Version": "2.0.0",
      "Provider": "Illumina",
      "Type": "DATA"
    }
  ]
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.connected.illumina.com/dragen-stratamap/dragen-spatial-transcriptome/getting-started/dragen-app-manager-local/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
