Pyani

Introduction

Pyani is an application and Python module for whole-genome classification of microbes using Average Nucleotide Identity.

For more information, please check:

Note

Please follow the recommended citation guidelines from the developers when you use the tool in research.

Versions

Cluster

Version(s)

ANVIL

0.2.11, 0.2.12

BELL

0.2.11, 0.2.12

GAUTSCHI

0.2.11, 0.2.12

NEGISHI

0.2.11, 0.2.12

SCHOLAR

0.2.11, 0.2.12

Commands

  • average_nucleotide_identity.py

  • genbank_get_genomes_by_taxon.py

  • delta_filter_wrapper.py

Module

You can load the modules by:

module load biocontainers
module load pyani

Example job

Warning

Using #!/bin/sh -l as shebang in the slurm job script will cause the failure of some biocontainer modules. Please use #!/bin/bash instead.

To run pyani on our clusters:

#!/bin/bash
#SBATCH -A myallocation     # Allocation name
#SBATCH -p wholenode        # Partition name
#SBATCH -t 1:00:00
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --job-name=pyani
#SBATCH --mail-type=FAIL,BEGIN,END
#SBATCH --error=%x-%J-%u.err
#SBATCH --output=%x-%J-%u.out

module --force purge
module biocontainers pyani

# Your pyani workflow...
#!/bin/bash
#SBATCH -A mygroup     # Group name
#SBATCH -p cpu         # Partition name
#SBATCH -q normal      # QOS name (optional)
#SBATCH -t 1:00:00
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --job-name=pyani
#SBATCH --mail-type=FAIL,BEGIN,END
#SBATCH --error=%x-%J-%u.err
#SBATCH --output=%x-%J-%u.out

module --force purge
module biocontainers pyani

# Your pyani workflow...
#!/bin/bash
#SBATCH -A mygroup     # Group name
#SBATCH -p ai          # Partition name
#SBATCH --gres=gpu:1   # Number of GPUs
#SBATCH -q normal      # QOS name (optional)
#SBATCH -t 1:00:00
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --job-name=pyani
#SBATCH --mail-type=FAIL,BEGIN,END
#SBATCH --error=%x-%J-%u.err
#SBATCH --output=%x-%J-%u.out

module --force purge
module biocontainers pyani

# Your pyani workflow...
#!/bin/bash
#SBATCH -A mygroup     # Group name
#SBATCH -p a100        # Partition name
#SBATCH --gres=gpu:1   # Number of GPUs
#SBATCH --mem=2G       # Memory
#SBATCH -q normal      # QOS name (optional)
#SBATCH -t 1:00:00
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --job-name=pyani
#SBATCH --mail-type=FAIL,BEGIN,END
#SBATCH --error=%x-%J-%u.err
#SBATCH --output=%x-%J-%u.out

module --force purge
module biocontainers pyani

# Your pyani workflow...
#!/bin/bash
#SBATCH -A queue     # Queue name
#SBATCH -t 1:00:00
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --job-name=pyani
#SBATCH --mail-type=FAIL,BEGIN,END
#SBATCH --error=%x-%J-%u.err
#SBATCH --output=%x-%J-%u.out

module --force purge
module biocontainers pyani

# Your pyani workflow...