Project 'anaee-dev/si-ore-v2' was moved to 'anaee-dev/openadom/frontend'. Please update any links and bookmarks that may still have the old path.
Newer
Older
Emilien Lasguignes
committed
How to Install ?
================
Hereafter, you will find all the details about the intronSeeker installation.
Requirements
------------
IntronSeeker requires Python version 3.6 or above. You don't need to change your Python version because this is managed by your Conda environment.
Emilien Lasguignes
committed
It also needs Python packages and external softwares to work
correctly (all these dependancies and their versions are detailed in the file
requirements.txt). So, to make install easier, a conda enviromnent (grinder excluded)
has been created : Conda environment
(it is the [environment.yml](https://forgemia.inra.fr/emilien.lasguignes/intronSeeker/-/blob/master/config/environment.yml) file)
Emilien Lasguignes
committed
For an easy install, conda environments is recommended.
Follow [this tutorial](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) to install Miniconda.
For a faster installation, we advise you to use mamba, already available in the latest version of conda
Emilien Lasguignes
committed
## intronSeeker installation and environment configuration on genobioinfo
--------------------------------------------------------------------------
First, open a bash session if you are not already in bash (bash command).
### Clone intronSeeker code from Git.
Download all files and directories found at [URL](https://forgemia.inra.fr/emilien.lasguignes/intronSeeker)
Sarah Maman-Haddad
committed
```diff
$ git clone https://forgemia.inra.fr/emilien.lasguignes/intronSeeker.git
Cloning into 'intronSeeker'...
remote: Enumerating objects: 2364, done.
remote: Counting objects: 100% (2334/2334), done.
remote: Compressing objects: 100% (798/798), done.
remote: Total 2364 (delta 1538), reused 2313 (delta 1523), pack-reused 30
Receiving objects: 100% (2364/2364), 539.80 MiB | 54.32 MiB/s, done.
Resolving deltas: 100% (1556/1556), done.
Checking out files: 100% (153/153), done.
Sarah Maman-Haddad
committed
```
### Load our miniconda environment and use libmamba
Emilien Lasguignes
committed
Sarah Maman-Haddad
committed
$ conda install -n base --override-channels -c conda-forge mamba 'python_abi=*=*cp*'
### Set up intronSeeker
Emilien Lasguignes
committed
```diff
$ cd intronSeeker/
Sarah Maman-Haddad
committed
$ CONDA_SOLVER="libmamba" /bin/bash ./setup.sh
Emilien Lasguignes
committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
This script will install the Conda environment, configure the newly installed
environment and install Grinder and its dependencies (Perl modules) wich are not yet
available in conda. Grinder installation is performed in the Conda environment, so, despite
the missing conda package, its installation will only affect your
conda environment (i.e. you will be able to run Grinder only when the environment is activated).
You should get these messages in the standard output :
```
Begin installing intronSeeker...
Directory added to the PATH
Conda environment installing...
Solving environment: done
Downloading and Extracting Packages
libcurl-7.63.0 | 550 KB | ###################################################### | 100%
[...]
perl-uri-1.74 | 54 KB | ###################################################### | 100%
Preparing transaction: done
Verifying transaction: done
Executing transaction: done
#
# To activate this environment, use
#
# $ conda activate ISeeker_environment
#
# To deactivate an active environment, use
#
# $ conda deactivate
Conda environment installed.
Conda environment configuration...
Conda environment configured.
Installation done.
```
NB. Installation can be quite long due to the numerous grinder perl dependencies.
Emilien Lasguignes
committed
### Activate ISeeker_environment and test installation.
Emilien Lasguignes
committed
Before each use of intronSeeker, activate the conda environment with :
```diff
Emilien Lasguignes
committed
```
Now, your command prompt should be like this :
```
Emilien Lasguignes
committed
```
Finally, to test the installation, run the command :
```diff
Emilien Lasguignes
committed
```
You should get this message in standard ouput :
```
gffread testing...OK !
grinder testing...OK !
hisat2 testing...OK !
star testing...OK !
samtools testing...OK !
transdecoder testing...OK !
diamond testing...OK !
All the dependencies are correctly installed
```