README.md

# FastFold

## 安装
安装FastFold,你需要
+ Python 3.8 或者 3.9.

### 使用pip方式安装
fastfold whl包下载目录：[https://cancon.hpccube.com:65024/4/main/fastfold/dtk23.04](https://cancon.hpccube.com:65024/4/main/fastfold/dtk23.04)
根据对应的pytorch版本和python版本，下载对应fastfold的whl包

```shell
pip install fastfold* (下载的fastfold的whl包)
```

### 使用源码编译方式安装

#### 编译环境准备
提供2种环境准备方式：

1. 基于光源pytorch基础镜像环境：镜像下载地址：[https://sourcefind.cn/#/image/dcu/pytorch](https://sourcefind.cn/#/image/dcu/pytorch)，根据pytorch、python、dtk及系统下载对应的镜像版本。

2. 基于现有python环境：安装pytorch，pytorch whl包下载目录：[https://cancon.hpccube.com:65024/4/main/pytorch/dtk23.04](https://cancon.hpccube.com:65024/4/main/pytorch/dtk23.04)，根据python、dtk版本,下载对应pytorch的whl包。安装命令如下：
```shell
pip install torch* (下载的torch的whl包)
pip install setuptools==59.5.0 wheel
```

#### 源码编译安装
- 代码下载
```shell
git clone https://developer.hpccube.com/codes/aicomponent/fastfold  # 根据需要的分支进行切换
```

- 提供2种源码编译方式（进入fastfold目录）：
```
1. 编译whl包并安装
export CPLUS_INCLUDE_PATH=$ROCM_PATH/include:$ROCM_PATH/cuda/targets/x86_64-linux/include:$CPLUS_INCLUDE_PATH
python setup.py bdist_wheel 
pip install dist/fastfold*

2. 源码编译安装
export CPLUS_INCLUDE_PATH=$ROCM_PATH/include:$ROCM_PATH/cuda/targets/x86_64-linux/include:$CPLUS_INCLUDE_PATH
python3 setup.py install 
```

## 版本号查询
- python -c "import fastfold; print(fastfold.\_\_version__)"，版本号与官方版本同步，查询该软件的版本号，例如0.2.0；

## Known Issue
- 无

## Note
+ 若使用 pip install 下载安装过慢，可添加源：-i https://pypi.tuna.tsinghua.edu.cn/simple/
+ ROCM_PATH为dtk的路径，默认为/opt/dtkxxx

## 参考
- [README_ORIGIN](README_ORIGIN.md)