Skip to content

Commit

Permalink
Reorder local installation steps in documentation (#15)
Browse files Browse the repository at this point in the history
- First install non-Python dependencies and
lastly the package itself (with pip3)
- Add "sudo apt-get update" in step 1
- Add install python3-pip (for pip3) in step 1
- Remove redundant link to paml docs
- Fuse the cloning and pip3 steps in one step

* WSL2: manual mounting of Windows filesystem
- Add note about how to mount the Windows
file system in the WSL2 terminal, which is
initialized by default in the Linux home.
  • Loading branch information
Cecilia-Sensalari committed Apr 23, 2021
1 parent 3a316ad commit c8012e2
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,25 +82,17 @@ Without the use of a container the installation of *ksrates* and its dependencie
.. note::
WSL2 (Windows Subsystem for Linux 2) is a native Windows 10 feature that allows to run a GNU/Linux terminal without the use of a VM. It can be installed following the official `documentation <https://docs.microsoft.com/en-us/windows/wsl/install-win10#requirements>`__.

1. Clone the *ksrates* repository from `GitHub <https://github.com/VIB-PSB/ksrates>`__::

git clone https://github.com/VIB-PSB/ksrates
1. Most of non-Python dependencies can be installed with the following commands::

2. Install the tool and its Python dependencies using ``pip3``::

cd ksrates
pip3 install .

3. Most of non-Python dependencies can be installed witht the following commands::

sudo apt-get -yq install default-jdk build-essential ncbi-blast+ muscle mafft prank fasttree mcl phyml
sudo apt-get update && sudo apt-get -yq install python3-pip default-jdk build-essential ncbi-blast+ muscle mafft prank fasttree mcl phyml
wget -qO- https://get.nextflow.io | bash

Optionally make Nextflow accessible through your ``$PATH`` variable, for example::

sudo mv nextflow /usr/local/bin
4. Install PAML 4.9j from source (for more infromation see PAML installation `page <http://abacus.gene.ucl.ac.uk/software/#phylogenetic-analysis-by-maximum-likelihood-paml>`__) to avoid compatibility issues::
2. Install PAML 4.9j from source (for more infromation see PAML installation `page <http://abacus.gene.ucl.ac.uk/software/#phylogenetic-analysis-by-maximum-likelihood-paml>`__) to avoid compatibility issues::

wget http://abacus.gene.ucl.ac.uk/software/paml4.9j.tgz
tar -xzf paml4.9j.tgz
Expand All @@ -115,15 +107,22 @@ Without the use of a container the installation of *ksrates* and its dependencie
* Or move ``codeml`` to another directory (here assumed to be ``~/bin``) and add this directory to ``$PATH``, for the Bash shell by copying the following line to the shell initialization file (e.g. ``.bashrc``)::

export PATH=$PATH:~/bin
Please refer to PAML `website <http://abacus.gene.ucl.ac.uk/software/paml.html#download>`__ for more information about its installation.

5. Install I-ADHoRe 3.0 from its GitHub `page <https://github.com/VIB-PSB/i-ADHoRe>`__ (required only for collinearity analysis of genome data).
3. Install I-ADHoRe 3.0 from its GitHub `page <https://github.com/VIB-PSB/i-ADHoRe>`__ (required only for collinearity analysis of genome data).

4. Clone the *ksrates* repository from `GitHub <https://github.com/VIB-PSB/ksrates>`__ and install the package and its Python dependencies::

git clone https://github.com/VIB-PSB/ksrates
cd ksrates
pip3 install .


Testing your installation
=========================

.. note::
WSL2 users can enter the Windows file system from the terminal through e.g. ``cd mnt/c/Users/your_username``.

1. Clone the *ksrates* repository from `GitHub <https://github.com/VIB-PSB/ksrates>`__ to get the use case dataset::

git clone https://github.com/VIB-PSB/ksrates
Expand Down

0 comments on commit c8012e2

Please sign in to comment.