VirSorter2/fr: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Created page with "#SBATCH --time=00:30:00 #SBATCH --mem-per-cpu=2G #SBATCH --cpus-per-task=2")
 
No edit summary
 
(18 intermediate revisions by 2 users not shown)
Line 3: Line 3:




<div lang="en" dir="ltr" class="mw-content-ltr">
__TOC__  
__TOC__
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
L'outil [https://microbiomejournal.biomedcentral.com/articles/10.1186/s40168-020-00990-y VirSorter2] permet d’identifier les nouvelles séquences de virus.
[https://microbiomejournal.biomedcentral.com/articles/10.1186/s40168-020-00990-y VirSorter2] is a tool to identify new viral sequences.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Nous abordons ici l’installation et l’utilisation de VirSorter2 v2.2.4.
This page discusses how to install and use VirSorter2 v2.2.4.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Le code source et la documentation pour VirSorter2 se trouvent sur leur [https://github.com/jiarong/VirSorter2 page GitHub].
Source code and documentation for VirSorter2 can be found on their [https://github.com/jiarong/VirSorter2 GitHub page].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
N’oubliez pas de [https://microbiomejournal.biomedcentral.com/articles/10.1186/s40168-020-00990-y#citeas citer VirSorter2] si vous l’utilisez pour vos analyses.
Remember to [https://microbiomejournal.biomedcentral.com/articles/10.1186/s40168-020-00990-y#citeas cite] VirSorter2 if you use it for your analyses.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation dans un environnement virtuel Python ==
== Installing VirSorter2 in a Python virtual environment ==
Les étapes ci-dessous servent à installer VirSorter2 dans votre répertoire $HOME avec nos [http://pythonwheels.com/ wheels Python] préconstruits. Les wheels personnalisés se trouvent dans /cvmfs/soft.computecanada.ca/custom/python/wheelhouse/. Pour installer un wheel VirSorter2 dans un [[Python/fr#Créer_et_utiliser_un_environnement_virtuel_Python| environnement virtuel Python]], nous utilisons la commande <code>pip</code>.
These instructions install VirSorter2 in your <tt>$HOME</tt> directory using Alliance's prebuilt [http://pythonwheels.com/ Python wheels]. Custom Python wheels are stored in <code>/cvmfs/soft.computecanada.ca/custom/python/wheelhouse/</code>. To install a VirSorter2 wheel, we will use the <code>pip</code> command and install it into a [[Python#Creating_and_using_a_virtual_environment | Python virtual environment]].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
1. Chargez les modules nécessaires.
1. Load the necessary modules.
{{Command
{{Command
|module load python/3.8 hmmer/3.3.2 prodigal/2.6.3
|module load StdEnv/2020 python/3.8 hmmer/3.3.2 prodigal/2.6.3
}}
}}
2. Create and activate a Python virtual environment.
2. Créez et activez un environnement virtuel Python.
{{Commands
{{Commands
|virtualenv --no-download ~/ENV_virsorter
|virtualenv --no-download ~/ENV_virsorter
|source ~/ENV_virsorter/bin/activate
|source ~/ENV_virsorter/bin/activate
}}
}}
3. Install VirSorter2 v2.2.4 in the virtual environment.
3. Installez VirSorter2 v2.2.4 dans l’environnement virtuel.
{{Commands
{{Commands
|prompt=(ENV_virsorter) [name@server ~]
|prompt=(ENV_virsorter) [name@server ~]
Line 44: Line 31:
|pip install --no-index virsorter{{=}}{{=}}2.2.4
|pip install --no-index virsorter{{=}}{{=}}2.2.4
}}
}}
4. Validate it.
4. Validez l'installation.
{{Command
{{Command
|prompt=(ENV_virsorter) [name@server ~]
|prompt=(ENV_virsorter) [name@server ~]
|virsorter -h
|virsorter -h
}}
}}
5. Freeze the environment and requirements set.
5. Gelez l’environnement et les éléments requis (<i>requirements.txt</i>).
 
{{Command
{{Command
|prompt=(ENV_virsorter) [name@server ~]
|prompt=(ENV_virsorter) [name@server ~]
|pip freeze > ~/virsorter-2.2.4-requirements.txt
|pip freeze > ~/virsorter-2.2.4-requirements.txt
}}
}}
6. Download the database in <code>$SCRATCH</code> with the <code>--skip-deps-install</code> option to bypass conda installation and also because dependencies are already installed.
6. Téléchargez la base de données dans votre répertoire $SCRATCH en utilisant l'option <code>--skip-deps-install</code> pour ne pas installer conda et aussi parce que les dépendances sont déjà installées.
{{Command
{{Command
|prompt=(ENV_virsorter) [name@server ~]
|prompt=(ENV_virsorter) [name@server ~]
|virsorter setup --db-dir $SCRATCH/db -j 4 --skip-deps-install
|virsorter setup --db-dir $SCRATCH/db -j 4 --skip-deps-install
}}
}}
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
== Tester VirSorter2 ==
== Testing VirSorter2 ==
1. Désactivez votre environnement virtuel.
0. Deactivate your virtual environment
{{Command
{{Command
|deactivate
|deactivate
}}
}}
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
2. Téléchargez l’ensemble de données dans votre répertoire $SCRATCH.
1. Download the test dataset in <code>$SCRATCH</code>.
{{Command
{{Command
|wget -O $SCRATCH/test.fa https://raw.githubusercontent.com/jiarong/VirSorter2/master/test/8seq.fa
|wget -O $SCRATCH/test.fa https://raw.githubusercontent.com/jiarong/VirSorter2/master/test/8seq.fa
}}
}}
2. Create a submission script
3. Créez un script pour soumettre une tâche à l’ordonnanceur.
{{File
{{File
|name=test-virsorter.sh
|name=test-virsorter.sh
Line 80: Line 64:
|contents=
|contents=
#!/bin/bash
#!/bin/bash
</div>


#SBATCH --time=00:30:00
#SBATCH --time=00:30:00
Line 86: Line 69:
#SBATCH --cpus-per-task=2
#SBATCH --cpus-per-task=2


<div lang="en" dir="ltr" class="mw-content-ltr">
# Load modules dependencies
# Load modules dependencies
module load python/3.8 hmmer/3.3.2 prodigal/2.6.3
module load StdEnv/2020 python/3.8 hmmer/3.3.2 prodigal/2.6.3
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
# Generate your virtual environment in $SLURM_TMPDIR
# Generate your virtual environment in $SLURM_TMPDIR
virtualenv --no-download $SLURM_TMPDIR/ENV
virtualenv --no-download $SLURM_TMPDIR/ENV
source $SLURM_TMPDIR/ENV/bin/activate
source $SLURM_TMPDIR/ENV/bin/activate
pip install --no-index --upgrade pip
pip install --no-index --upgrade pip
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
# Install VirSorter2 and its dependencies
# Install VirSorter2 and its dependencies
pip install --no-index -r ~/virsorter-2.2.4-requirements.txt
pip install --no-index -r ~/virsorter-2.2.4-requirements.txt
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
# Run VirSorter2 with the test dataset, using at most $SLURM_CPUS_PER_TASK and ignore conda.
# Run VirSorter2 with the test dataset, using at most $SLURM_CPUS_PER_TASK and ignore conda.
# The database must already exist and you must specify its location.
# The database must already exist and you must specify its location.
virsorter run -w $SCRATCH/test.out -i $SCRATCH/test.fa --min-length 1500 -j $SLURM_CPUS_PER_TASK --verbose --use-conda-off --db-dir $SCRATCH/db all
virsorter run -w $SCRATCH/test.out -i $SCRATCH/test.fa --min-length 1500 -j $SLURM_CPUS_PER_TASK --verbose --use-conda-off --db-dir $SCRATCH/db all
}}
}}
3. Start an interactive job.
3. Lancez une tâche interactive.
{{Command
{{Command
|salloc --mem-per-cpu{{=}}2G --cpus-per-task{{=}}2 --account{{=}}<your-account>
|salloc --mem-per-cpu{{=}}2G --cpus-per-task{{=}}2 --account{{=}}<your-account>
Line 116: Line 92:
  $ exit                              # Terminate the allocation
  $ exit                              # Terminate the allocation
  salloc: Relinquishing job allocation 1234567
  salloc: Relinquishing job allocation 1234567
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Si le test est réussi, vous pouvez utiliser la commande <code>sbatch</code> pour soumettre une tâche avec votre propre ensemble de données.
Upon a successful test run, you can submit a non-interactive job with your own dataset using [https://docs.alliancecan.ca/wiki/Running_jobs#Use_sbatch_to_submit_jobs <code>sbatch</code>].
</div>

Latest revision as of 19:44, 15 July 2024

Other languages:


L'outil VirSorter2 permet d’identifier les nouvelles séquences de virus.

Nous abordons ici l’installation et l’utilisation de VirSorter2 v2.2.4.

Le code source et la documentation pour VirSorter2 se trouvent sur leur page GitHub.

N’oubliez pas de citer VirSorter2 si vous l’utilisez pour vos analyses.

Installation dans un environnement virtuel Python

Les étapes ci-dessous servent à installer VirSorter2 dans votre répertoire $HOME avec nos wheels Python préconstruits. Les wheels personnalisés se trouvent dans /cvmfs/soft.computecanada.ca/custom/python/wheelhouse/. Pour installer un wheel VirSorter2 dans un environnement virtuel Python, nous utilisons la commande pip.

1. Chargez les modules nécessaires.

Question.png 
[name@server ~]$ module load StdEnv/2020 python/3.8 hmmer/3.3.2 prodigal/2.6.3

2. Créez et activez un environnement virtuel Python. 

[name@server ~]$ virtualenv --no-download ~/ENV_virsorter
[name@server ~]$ source ~/ENV_virsorter/bin/activate

3. Installez VirSorter2 v2.2.4 dans l’environnement virtuel. 

(ENV_virsorter) [name@server ~] pip install --no-index --upgrade pip
(ENV_virsorter) [name@server ~] pip install --no-index virsorter==2.2.4

4. Validez l'installation.

Question.png 
(ENV_virsorter) [name@server ~] virsorter -h

5. Gelez l’environnement et les éléments requis (requirements.txt).

Question.png 
(ENV_virsorter) [name@server ~] pip freeze > ~/virsorter-2.2.4-requirements.txt

6. Téléchargez la base de données dans votre répertoire $SCRATCH en utilisant l'option --skip-deps-install pour ne pas installer conda et aussi parce que les dépendances sont déjà installées.

Question.png 
(ENV_virsorter) [name@server ~] virsorter setup --db-dir $SCRATCH/db -j 4 --skip-deps-install

Tester VirSorter2

1. Désactivez votre environnement virtuel.

Question.png 
[name@server ~]$ deactivate

2. Téléchargez l’ensemble de données dans votre répertoire $SCRATCH.

Question.png 
[name@server ~]$ wget -O $SCRATCH/test.fa https://raw.githubusercontent.com/jiarong/VirSorter2/master/test/8seq.fa

3. Créez un script pour soumettre une tâche à l’ordonnanceur.

File : test-virsorter.sh

#!/bin/bash

#SBATCH --time=00:30:00
#SBATCH --mem-per-cpu=2G
#SBATCH --cpus-per-task=2

# Load modules dependencies
module load StdEnv/2020 python/3.8 hmmer/3.3.2 prodigal/2.6.3

# Generate your virtual environment in $SLURM_TMPDIR
virtualenv --no-download $SLURM_TMPDIR/ENV
source $SLURM_TMPDIR/ENV/bin/activate
pip install --no-index --upgrade pip

# Install VirSorter2 and its dependencies
pip install --no-index -r ~/virsorter-2.2.4-requirements.txt

# Run VirSorter2 with the test dataset, using at most $SLURM_CPUS_PER_TASK and ignore conda.
# The database must already exist and you must specify its location.
virsorter run -w $SCRATCH/test.out -i $SCRATCH/test.fa --min-length 1500 -j $SLURM_CPUS_PER_TASK --verbose --use-conda-off --db-dir $SCRATCH/db all


3. Lancez une tâche interactive.

Question.png 
[name@server ~]$ salloc --mem-per-cpu=2G --cpus-per-task=2 --account=<your-account>

salloc: Granted job allocation 1234567
$ bash test-virsorter.sh             # Run the submission script
$ exit                               # Terminate the allocation
salloc: Relinquishing job allocation 1234567

Si le test est réussi, vous pouvez utiliser la commande sbatch pour soumettre une tâche avec votre propre ensemble de données.

Retrieved from "https://docs.alliancecan.ca/mediawiki/index.php?title=VirSorter2/fr&oldid=157658"