Public alpha installation

Prepare the analysis data and validated environment profile

Before analysis, the user or system administrator must prepare the required containers, reference data, indices, and environment profile. Vendor terms, registry sign-in, and downloads are not handled automatically; review and complete these steps independently.

Tested setup

Operating systemUbuntu 24.04.4 LTS running directly on Linux, not through WSL
GPUNVIDIA GeForce RTX 3090 with 24 GiB VRAM and a compatible driver
Memory128 GB of physical RAM
Active storageA local, high-speed ext4 SSD with sufficient free capacity. Do not use a slow hard drive or network storage as the Nextflow workDir.
Container runtimeDocker Engine and NVIDIA Container Toolkit
Workflow engineJava 17 or later and Nextflow 25.04.3
ApplicationPython 3.11 or later and Harako-GPU v0.1.0-alpha.1
Alignment imageParabricks 4.6.0-1 with a verified source, version, and runtime image ID
Reference dataThe fixed GRCh38.p14 / GENCODE 49 reference pack, STAR 2.7.2a index, and the selected Salmon 2.5.1 and/or 1.10.3 index
Environment profileA validated environment profile created by the system administrator, with matching analysis reports and the plugin and container records required by the selected backend

Download the release

The v0.1.0-alpha.1 wheel and source distribution are available from GitHub Releases.

They contain the Harako-GPU application only. Parabricks, container images, reference sequences, annotations, and STAR/Salmon indices must be provisioned separately.

Install from a fresh source clone

You can also install the application directly from source:

git clone https://github.com/do-shima/Harako-GPU.git
cd Harako-GPU
python3 -m venv .venv
. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
harako-gpu --version
harako-gpu doctor --json
harako-gpu ui --no-browser

Prepare the required containers and reference data

  1. Install Docker Engine and NVIDIA Container Toolkit by following their official documentation.
  2. Obtain Parabricks 4.6.0-1 from official NVIDIA NGC. Review and accept NVIDIA's terms independently before using it.
  3. Prepare the required task-container images with their pinned versions and checksums. Run preparation checks them and stops before launch if a selected image is missing; it never pulls images automatically.
  4. Place the fixed reference pack and version-specific indices outside the Git repository.
  5. Copy the validated environment profile created by the system administrator to <runtime-root>/host-profiles/ubuntu_native_rtx3090_ram128_v1.json. Creating a plan does not generate or modify this file.
  6. Run harako-gpu doctor --json, review the reported capabilities, and then create and review a plan without starting an RNA-seq analysis.

This repository does not distribute Parabricks, reference data, indices, plugin binaries, container archives, FASTQ, or BAM files. Their licenses and terms apply independently.

Other environments

Not yet tested

Other Ubuntu releases, RTX models, RAM capacities, driver versions, storage layouts, and custom references require separate prospective testing. Hardware detection alone is not enough to enable an RNA-seq run.

Unavailable in the validated configuration

The validated configuration does not support BAM generation with the fixed 64 GB Windows/WSL host, CPU STAR, macOS, or active work on NTFS, fuseblk, SMB, CIFS, NFS, /mnt/c, /mnt/d, or unsafe paths.