Skip to Content
AdministrationPipeline Runtime

Pipeline Runtime

Pipeline runtime settings control how Nextflow workflows are executed — locally or on a SLURM cluster — and which tools are available.

Configuration Location

Pipeline runtime settings are at Admin → Pipeline Runtime (/admin/pipeline-runtime), or via the config file / environment variables.

Execution Mode

ModeDescriptionBest For
localRun Nextflow directly on the serverTesting, small datasets
slurmSubmit jobs to a SLURM clusterProduction, large datasets

Local Execution

Nextflow runs as a child process on the SeqDesk server. All compute happens on the same machine.

SLURM Execution

Nextflow submits individual processes as SLURM jobs. Configure:

SettingEnv VariableDefaultDescription
SLURM EnabledSEQDESK_SLURM_ENABLEDfalseEnable SLURM
QueueSEQDESK_SLURM_QUEUEdefaultPartition name
CoresSEQDESK_SLURM_CORES4CPUs per job
MemorySEQDESK_SLURM_MEMORY16GBMemory per job
Time LimitSEQDESK_SLURM_TIME24Hours per job
Additional OptionsExtra SLURM flags

Conda Configuration

Nextflow pipelines use Conda for dependency management:

SettingEnv VariableDefaultDescription
Conda EnabledSEQDESK_CONDA_ENABLEDfalseUse Conda
Conda PathSEQDESK_CONDA_PATH/opt/condaInstallation path
Conda EnvironmentSEQDESK_CONDA_ENVEnvironment name

The Conda environment must have Nextflow installed or be configured to find it.

Nextflow Settings

Additional Nextflow configuration available in the admin UI:

  • Nextflow path — path to the Nextflow binary
  • Nextflow profile — profile name to use (e.g., conda, docker)
  • Database download paths — paths for reference databases (GTDB-Tk, etc.)

Weblog Setup

Real-time pipeline monitoring requires configuring the Nextflow weblog:

SettingDescription
Weblog URLYour SeqDesk URL + /api/pipelines/weblog
Weblog SecretOptional authentication token

The weblog URL is automatically included in the Nextflow execution command. See Monitoring & DAG Visualization for details.

Pipeline Run Directory

SettingEnv VariableDefaultDescription
Run DirectorySEQDESK_PIPELINE_RUN_DIR./pipeline_runsWhere run outputs are stored

Each pipeline run creates a subdirectory (e.g., MAG-20240126-001/) containing the samplesheet, scripts, logs, and outputs.

Infrastructure Validation

The Admin → Infrastructure page (/admin/data-compute) validates that your runtime environment is correctly configured before you run any pipelines. It tests four areas:

CheckWhat It Tests
Data PathThe sequencing data directory exists and is accessible
Run DirectoryThe pipeline run directory exists and is writable
CondaConda is installed and the configured environment is available
WeblogThe Nextflow weblog endpoint is reachable

Each check shows a pass/fail indicator. Fix any failures before attempting to run a pipeline.

Import Setup JSON

The infrastructure page also supports importing a complete infrastructure configuration as JSON. You can:

  • Upload a JSON file or paste a configuration
  • Load an example to see the expected format
  • Validate (dry-run) before saving
  • Save to apply the configuration

This is useful for automating setup or copying configurations between instances. The JSON supports both flat keys (e.g., dataBasePath) and nested keys (e.g., site.dataBasePath), as well as alternate names for flexibility.