.. _pangolin:

pangolin の 準備
======================

| SHIROKANE で pangolin を使う準備をします。

.. note::

  **pangolinのアップデート**

  | pangolin で使われる lineage 情報は逐次更新されます。
  | ( パイプライン内で使われている lineage 情報は2021年6月10日時点での情報です。)
  |
  | pangolin をユーザー自身がインストールしなくても解析は可能ですが
  | 最新の lineage 情報で解析したい場合には pangolin を自分のディレクトリにインストールし、
  | そのパスをパイプライン設定ファイルで指定する必要があります。

| pangolin については
| https://cov-lineages.org/pangolin.html
| を見てください。


1. conda
-------------------------------------

| conda を準備します。(`https://supcom.hgc.jp/internal/mediawiki/Miniconda_使用方法 <https://supcom.hgc.jp/internal/mediawiki/Miniconda_使用方法>`_ )。

.. code-block:: bash

  [username@gc016 ~]$ wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
  [username@gc016 ~]$ bash Miniconda3-latest-Linux-x86_64.sh

2. pangolin のダウンロード
-------------------------------------

| github から pangolin をダウンロードします。

.. code-block:: bash

  [username@gc016 ~]$ wget https://github.com/cov-lineages/pangolin/archive/refs/heads/master.zip
  [username@gc016 ~]$ unzip master.zip
  [username@gc016 ~]$ rm  master.zip

| master.zip を解凍すると pangolin-master というフォルダが生成します。

3. pangolin のインストール
-------------------------------------

| pangolin をインストールします。

.. code-block:: bash

  [username@gc016 ~]$ cd pangolin-master
  [username@gc016 ~]$ eval "$(~/miniconda3/bin/conda shell.bash hook)"
  [username@gc016 ~]$ conda env create -f environment.yml
  [username@gc016 ~]$ conda activate pangolin
  [username@gc016 ~]$ python setup.py install

4. pangolin のアップデート
-------------------------------------

| pangolin をアップデートします。

.. code-block:: bash

  [username@gc016 ~]$ pangolin --update

5. パイプライン設定ファイルに conda のパスを追加
-------------------------------------------------

| パイプライン設定ファイルの pangolin_dir を書き換えます。

.. code-block:: bash

  pangolin_dir = '~/miniconda3'


6. 参考
-----------------------------------------------

| 一連の操作をシェルスクリプトで自動化すると以下のようになります。

.. code-block:: bash 
  :caption: pangolin_installer.sh

  if [ ! -e Miniconda3-latest-Linux-x86_64.sh ]; then
    wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
  fi

  if [ -e ~/miniconda3 ]; then
      echo "~/miniconda3 exists. Please delete  ~/miniconda3"
      exit 1
  fi

  expect -c "
  set timeout 600
  spawn bash  Miniconda3-latest-Linux-x86_64.sh
  expect \">>>\"
  send -- \"\n\"
  expect \":\"
  send -- \"            \"
  expect \">>>\"
  send -- \"yes\n\"
  expect \">>>\"
  send -- \"\n\"
  expect \">>>\"
  send -- \"\n\"
  expect \"$\"
  exit 0
  "

  if [ -e  master.zip ]; then
      echo "master.zip exists. Please delete master.zip"
      exit 1
  fi

  wget https://github.com/cov-lineages/pangolin/archive/refs/heads/master.zip
  unzip master.zip
  rm master.zip

  cd pangolin-master
  eval "$(~/miniconda3/bin/conda shell.bash hook)"
  conda env create -f environment.yml
  conda activate pangolin
  python setup.py install
  conda deactivate

.. code-block:: bash
  :caption: pangolin_updater.sh

  eval "$(~/miniconda3/bin/conda shell.bash hook)"
  conda activate pangolin
  pangolin --update
  conda deactivate

| シェルスクリプトを実行するときは以下のようにします。

.. code-block:: bash

  [username@gc016 ~]$ bash pangolin_installer.sh
  [username@gc016 ~]$ bash pangolin_updater.sh