labsyspharm/minerva-cli

Minerva CLI

镜像概述

Minerva命令行界面（CLI）允许用户向Minerva Cloud系统上传、导入和导出显微镜图像，帮助用户高效管理显微镜图像数据。

核心功能

• 上传显微镜图像到Minerva Cloud
• 从本地或指定目录导入图像到Minerva Cloud
• 从Minerva Cloud导出OME-TIFF格式图像到本地磁盘
• 支持通过配置文件或环境变量设置连接参数

使用场景

• 本地目录显微镜图像批量导入Minerva Cloud
• 从O2系统（如Harvard HMS的O2集群）导入图像到Minerva Cloud
• 从Minerva Cloud导出图像进行本地分析

配置说明

Minerva默认会在用户主目录查找名为.minerva的配置文件并加载配置，以连接到正确的Minerva服务。命令行参数会覆盖配置文件中的值，可通过--config [PATH]指定配置文件路径。

配置文件设置

复制示例配置文件到主目录并编辑：

bash
cp .minerva.example ~/.minerva
# 使用文本编辑器修改配置值
nano ~/.minerva
# 设置文件权限防止他人读取
chmod 700 ~/.minerva

环境变量设置

所有配置参数也可通过环境变量设置：

• MINERVA_REGION = us-east-1（Minerva安装的AWS区域）
• MINERVA_USERNAME = Minerva用户名
• MINERVA_PASSWORD = Minerva密码
• MINERVA_ENDPOINT = API网关阶段URL（例如：https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/dev%EF%BC%89
• MINERVA_CLIENT_ID = 用户池的Cognito应用客户端ID

查看帮助

bash
python minerva.py

导入图像到Minerva Cloud

bash
# 替换<REPOSITORY>为仓库名称，<DIRECTORY>为目录路径，导入目录及其子目录下的所有图像
python minerva.py import -r <REPOSITORY> -d <DIRECTORY>

在O2系统上运行

安装步骤

bash
# 通过SSH登录O2
ssh ecommonsid@o2.hms.harvard.edu
# 克隆minerva-cli仓库
git clone https://github.com/labsyspharm/minerva-cli.git
# 加载必要模块（首次运行后可能需重启bash）
module load conda2
# 创建并激活conda环境
conda create --name minerva python=3.6
conda activate minerva
pip install -r requirements.txt
# 配置minerva.config
cp .minerva.example ~/.minerva
nano ~/.minerva
chmod 700 ~/.minerva

从ImStor导入图像到Minerva Cloud

bash
# 登录O2传输节点
ssh ecommonsid@transfer.rc.hms.harvard.edu
# 将ImStor中的图像复制到scratch空间
mkdir -p /n/scratch3/$USER/dataset
cp /n/files/ImStor/.../image.ome.tif /n/scratch3/$USER/dataset
# 登录O2并启动交互式会话
ssh ecommons@o2.hms.harvard.edu
srun --pty -p interactive --mem 500M -t 0-06:00 /bin/bash
# 激活环境并导入图像
conda activate minerva
python $HOME/minerva-cli/minerva.py import -r [REPOSITORY] -d /n/scratch3/$USER/dataset

从Minerva Cloud导出OME-TIFF到本地磁盘

bash
# 导出图像（默认名称）并仅保存最高金字塔层级
python minerva.py export --id [IMAGE_UUID]