Snakemake调用Singularity时Docker环境PATH被覆盖的解决问询

问题背景 #

使用Docker构建基于micromamba的镜像时，/opt/conda/bin已包含在PATH中，直接运行Docker容器可正常执行工具（如reformat.sh）。但通过Snakemake调用Singularity运行该镜像时，容器内的PATH被用户主机PATH覆盖，导致找不到工具命令。手动在每个rule的shell中追加PATH可临时解决，但重复代码过多。

补充测试发现：直接执行singularity run --cleanenv /path/to/image.simg可正常保留容器PATH，但Snakemake底层使用singularity exec，传递--cleanenv参数后未生效。

解决方案 #

1. 修正Dockerfile，永久设置PATH #

原Dockerfile中RUN export PATH="$PATH:/opt/conda/bin"仅为临时设置，不会被Singularity继承。需改为ENV指令持久化环境变量：

# Dockerfile
FROM mambaorg/micromamba@sha256:1dee8bc9409368d83d08b0a93370422a4fe0fd0092f56819bbf4c4cb254a8183
RUN mkdir -p /usr/bin
WORKDIR /usr/bin
# 用ENV替代RUN export，持久化PATH
ENV PATH="$PATH:/opt/conda/bin"

ARG ENV_YML
COPY --chown=$MAMBA_USER:$MAMBA_USER ${ENV_YML} /usr/bin/${ENV_YML}
RUN micromamba install -y -n base -f /usr/bin/${ENV_YML} && \
    micromamba clean --all --yes

重新构建镜像后，Singularity会继承该PATH设置。

2. 全局配置Snakemake的Singularity参数 #

通过命令行或Snakefile全局设置Singularity参数，强制保留容器PATH：

• 命令行方式：传递--cleanenv清除主机环境变量，或直接指定PATH：

  snakemake --cores 1 --snakefile example/Snakefile --configfile config/config_test.yml --use-singularity --singularity-args "--cleanenv"
  

  或精准指定PATH：

  snakemake --cores 1 --snakefile example/Snakefile --configfile config/config_test.yml --use-singularity --singularity-args "--env PATH=/opt/conda/bin:$PATH"
  

• Snakefile全局配置：避免每次命令行输入，在Snakefile开头添加：

  # 全局设置Singularity参数
  singularity_args = "--cleanenv"
  # 或指定PATH
  # singularity_args = "--env PATH=/opt/conda/bin:$PATH"
  

3. 设置Snakefile全局Shell前缀 #

在Snakefile中定义全局shell前缀，自动为所有rule追加PATH设置：

# 在Snakefile开头添加
shell.prefix("export PATH=/opt/conda/bin:$PATH && ")

# 后续rule无需重复写PATH设置
rule example:
    output:
      somefile.txt
    shell:
      """
      (reformat.sh) 2> {log}
      """

内容的提问来源于stack exchange，提问作者spo