下载与安装

GBC 是基于 Oracle JDK 8 开发的应用程序,任何兼容支持或兼容 Oracle JDK 8 的计算机设备都可以使用我们的软件。用户需要先下载安装 Oracle JDKOpen JDK。Apple Silicon 设备可以使用 zulu JDK 作为替代。此外,我们也提供 Dockerfile 构建 GBC 的运行环境镜像。

资源类型 路径
软件包 http://pmglab.top/gbc/download/gbc-stable-1.0.jar
说明文档 http://pmglab.top/gbc/
API 文档 http://pmglab.top/gbc/api-docs/
示例数据 http://pmglab.top/genotypes/#/

下载软件包

# 下载 GBC 软件包
wget http://pmglab.top/gbc/download/gbc-stable-1.0.jar -O gbc.jar

# 运行 GBC 软件包
java -jar gbc.jar

通过 Docker 运行 GBC

# 下载 GBC 的 Dockerfile 文件
wget http://pmglab.top/gbc/download/Dockerfile -O Dockerfile

# 从 Dockerfile 文件构建镜像
docker build -t gbc .

# 运行 GBC 软件包
docker run -it --rm gbc

# 删除 GBC 镜像及其缓存
docker image rm gbc & docker system prune -f

[!TIP|label:从 Docker Hub 获取 GBC|style:callout]

我们使用如下指令构建了适用于 amd64 和 arm64 的 GBC 镜像,使用 docker pull suranyi/gbc && docker tag suranyi/gbc gbc 即可获取。

# 创建多平台构建器
docker buildx create --name multibuilder && docker buildx use multibuilder && docker buildx inspect --bootstrap

# 登陆
docker login

# 推送到 docker 仓库
docker buildx build --platform linux/amd64,linux/arm64 -t suranyi/gbc:latest --push .

运行要求

GBC 进行了严格的内存需求控制,对于小规模的基因组数据,通常可以以默认内存分配量运行。对于大规模的基因组数据,GBC 单线程的内存使用量最多不超过 2 GB。因此,我们建议在始终不小于 4 GB 的堆内存中运行 GBC 程序。用户通过以下指令分配 GBC 的运行时堆内存:

java -Xms4g -Xmx4g -jar gbc.jar

使用 Docker 运行 GBC 时,我们推荐使用以下模版指令:

# Macos 或 Linux
docker run -v `pwd`:`pwd` -w `pwd` --rm -it -m 4g gbc

# Windows - cmd
docker run -v `pwd`:/.cache/ -w /.cache/ --rm -it -m 4g gbc

在该语句中,-v 表示将指定的主机路径映射到容器路径 (宿主机路径:容器路径),-w 表示设置当前工作路径 (相当于运行 cd 指令),-it 表示在交互式终端中运行,-m 4g 表示设置 JVM 最大堆大小为 4GB。

更新日志

GBC 的第一个稳定版本为 gbc-stable-1.0,第一个代码 1 表示 GTB 文件架构版本,第二个代码 0 代表功能版本。当 GTB 文件架构发生重大更新,以至于无法兼容旧版本时,架构版本将更新。功能版本更新仅在一些高性能计算方法被加入时进行。

[!UPDATE|label:2023/04/11|style:callout]

发布 GBC 的稳定版本 stable-1.0。稳定版本是一个全面优化的版本, 支持测试版本的所有功能, 并提供更友好和高效的 API 功能。

[!UPDATE|label:2022/06/20|style:callout]

发布 GBC 的测试版本,版本号: version for publication。

Copyright ©张柳彬 all right reserved文档修订时间: 2023-04-19 07:59:50

results matching ""

    No results matching ""