Skip to content

Commit

Permalink
updating install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Saary committed May 18, 2020
1 parent 937702d commit 3b2ddb1
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 40 deletions.
7 changes: 7 additions & 0 deletions docs/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Make first sure you have the PyQt5 library installed and if the error persists
you can try to install `libgl1-mesa-glx` on your operating system or in your
container.

Cwd.c: loadable library and perl binaries are mismatched
---------------------------------------------------------------------------------
We noticed this warning when using perl from conda. This is caused by compilations of
perl modules from an older or newer perl library.
it is caused by modules needed for GeneMark-ES. Try debugging by running `gmes_petap.pl`
in the command line. It should output a help page.

EukCC fails to run
=====================

Expand Down
67 changes: 27 additions & 40 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,47 @@
Installation
---------------

Install dependencies
~~~~~~~~~~~~~~~~~~~~~~
EukCC depends on hmmer, Genemark-ES and pplacer. So you will need to install
them before launching EukCC. It is best to create a conda enviorement
and then install Genemark-ES manually.
EukCC is avaliable to install from bioconda (https://anaconda.org/bioconda/eukcc)
or pypi (https://pypi.org/project/eukcc/).

You can also fetch the source code from GitHub: /~https://github.com/Finn-Lab/EukCC/

Install via conda
~~~~~~~~~~~~~~~~~~~~~~
Installing EukCC via conda will install all dependencies
**except for GeneMark-ES**. If you want to use GeneMark-ES
you will need to download a 64 bit version with the license here:
http://exon.gatech.edu/GeneMark/license_download.cgi

**With conda**
We noticed that insaling perl and modules for GeneMark-ES
can lead to problems. If you have any issues feel free to open an issue
at Github: /~https://github.com/Finn-Lab/EukCC/issues

.. code-block:: shell
conda create -n eukcc -c bioconda -c biocore hmmer>3.2 pplacer python=3.7
# we recommend installing ete3 from conda:
conda activate eukcc
conda install -c etetoolkit -c anaconda ete3 pyqt>5
conda install -c bioconda -c conda-forge eukcc
To install GeneMark-ES you will need to install perl and certain perl packages:
To install GeneMark-ES you will need to install perl and certain perl packages.
This could look like this:

.. code-block:: shell
conda activate eukcc
conda install -c anaconda perl \
-c bioconda perl-app-cpanminus
cpanm Test::Pod
cpanm Logger::Simple
cpanm Parallel::ForkManager.pm
cpanm YAML
cpanm Hash::Merge module
apt install -y cpanminus make gcc dialog
cpanm inc::Module::Install::DSL Hash::Merge MCE::Mutex FindBin Test::Pod Logger::Simple Parallel::ForkManager.pm YAML
Once you installed these dependencies you need to download GeneMark-ES
from http://exon.gatech.edu/GeneMark/license_download.cgi and deposit the
license key in your home directory as `.gm_key`.

.. code-block:: shell
tar -xzvf gmes_linux_64.tar.gz
cp gmes_linux_64/* ~/local/bin/
# extract the key file
zcat gm_key.gz > ~/.gm_key
Make sure `gmes_petap.pl` and `get_sequence_from_GTF.pl` are availiable from your $PATH:

.. code-block:: shell
Expand All @@ -43,28 +51,8 @@ Make sure `gmes_petap.pl` and `get_sequence_from_GTF.pl` are availiable from yo
#~/software/genemark_es/gmes_petap.pl
Install EukCC
~~~~~~~~~~~~~~~~

**Install from github (access required)**

Fetch from github and install in the conda environment:

.. code-block:: shell
git clone /~https://github.com/Finn-Lab/EukCC/ eukcc
cd eukcc
conda activate eukcc
pip install . # might be pip3 if you have two versions of python in your path
EukCC requires python 3.7

**Get database from the EBI cluster**

This will only work for EBI users and this section will be removed in
the future.

.. code-block:: shell
wget http://ftp.ebi.ac.uk/pub/databases/metagenomics/eukcc/eukcc_db_v1.1.tar.gz
Expand Down Expand Up @@ -94,4 +82,3 @@ and test for function with this command:
--outdir eukcc_testgenome \
testgenome.fa

0 comments on commit 3b2ddb1

Please sign in to comment.