liserjrqlxue / kinship

kinship 亲缘关系判断小程序

TOC

• 部署
  • 依赖
  • 安装kinship服务器
    • 使用预编译的软件包
    • 使用源码编译安装
  • 安装使用依赖
    • pandas
    • SampleSimilarity
    • example use conda
• 使用
  • 启动服务
• 跨平台

部署

依赖

• build
  • go1.18
  • git
    • git-lfs
• run
  • python3
    • pandas
  • SampleSimilarity

安装kinship服务器

使用预编译的软件包

tar avxf kinship.tar.gz
cd kinship

注意: 如果您的系统不支持预编译的软件包，请使用源码编译安装。

使用源码编译安装

依赖 go1.18 和 git-lfs

git clone https://github.com/liserjrqlxue/kinship.git
cd kinship
go build
git lfs fetch
git lfs checkout

注意: 代码在一个不重要的地方使用了泛型，因此依赖 golang 的 1.18 版本， 如果您的系统暂不支持 1.18 版本（比如 alpine linux ）， 请修改源码降级后编译安装。

安装使用依赖

pandas

pip install pandas

SampleSimilarity

直接使用 src/ss/bin/SampleSimilarity 即可。 如果编译软件或者动态链接库不支持，更新对应依赖或者 参考 README.md 中的相关说明重新安装。

example use conda

示例使用 conda 安装 ngs-bits 和 python pandas

wget -m https://repo.anaconda.com/miniconda/Miniconda3-py39_4.11.0-Linux-x86_64.sh
sh repo.anaconda.com/miniconda/Miniconda3-py39_4.11.0-Linux-x86_64.sh
. ~/.bashrc
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
conda create -n ss ngs-bits pandas
conda activate ss

使用

启动服务

cd kinship
./kinship #-port :9091

然后访问 kinship 测试和使用。

注意: 网址中的 loclhost 可换成启动服务器的其它可访问ip或网址，默认端口为 :9091 ，可通过参数 -port 修改。

跨平台

本软件使用的 golang 和 python 可以在不同平台上编译或运行， SampleSimilarity 也可以在不同平台上安装运行。
但 SampleSimilarity 在 windows 上的安装较复杂，尚未测试，如果您有兴趣，请自行尝试。
目前在windows上的运行实例，是通过 WSL Ubuntu 实现的。
并基于此，将 SampleSimilarity 放入了 git lfs，部分 Linux 和 Windows WSL 用户可免于或减少安装 SampleSimilarity 的工作。