Installation

Warning

Supported python version are 3.8, 3.9 and 3.10

Installing PPanGGOLiN with Conda (recommended)

The best way to install PPanGGOLiN is through conda, accessible through the bioconda channel. To ensure a smoother installation and avoid conflicting dependencies, it’s highly recommended to create a dedicated environment for PPanGGOLiN:

# Install into a new conda environment
conda create -n ppanggo -c defaults -c conda-forge -c bioconda ppanggolin

# Check PPanGGOLiN install
conda activate ppanggo
ppanggolin --version

Tip

For quicker installation and potential resolution of conflicting dependencies, consider using Mamba, an efficient alternative to conda.

Installing from Source Code (GitHub)

Within a Conda Environment

A straightforward method to install PPanGGOLiN from the source code is by utilizing a conda environment that includes all the necessary dependencies.

1. Clone the PPanGGOLiN Repository

git clone https://github.com/labgem/PPanGGOLiN.git
cd PPanGGOLiN

2. Installing Dependencies with a Conda Environment File

Install PPanGGOLiN dependencies listed in the ppanggolin_env.yaml file, located at the root of the repository, using conda:

conda env create -n ppanggolin_source -f ppanggolin_env.yaml

3. Installing PPanGGOLiN

Finally, install PPanGGOLiN using pip:

pip install .

Manual Installation

If you prefer to install PPanGGOLiN without using conda, follow these steps:

Warning

Please note that this method involves manual installation. While assistance is available, complete troubleshooting support may not be provided. We strongly recommend using the conda installation method whenever possible.

1. Clone the PPanGGOLiN Repository

git clone https://github.com/labgem/PPanGGOLiN.git
cd PPanGGOLiN

2. Installing PPanGGOLiN Dependencies

To ensure the tool functions correctly, you need to install all dependencies listed in the ppanggolin_env.yaml file.

Next, install the following non-Python software:

Note

MMSeqs2 is crucial for gene clustering, while Aragorn and Infernal are used for genome annotation.
MAFFT is utilized in the ppanggolin msa command for multiple sequence alignment.
Skip installing Aragorn, Infernal, or MAFFT if you do not require their specific features.

3. Installing PPanGGOLiN with its Python Dependencies

PPanGGOLiN’s Python dependencies are specified in the pyproject.toml file under the optional dependencies category named python_deps. This configuration file is situated at the root of the PPanGGOLiN repository.

To install PPanGGOLiN along with its Python dependencies, you can use the following pip command:

pip install .[python_deps]

Development Version

If you wish to utilize the development version of PPanGGOLiN, you can access the ‘dev’ branch on GitHub. Please note that while its functionality is not guaranteed, it typically works most of the time.

Follow these steps to obtain and install the development version:

1. Clone the Repository

Clone the ‘dev’ branch of the repository onto your local machine:

git clone --branch dev https://github.com/labgem/PPanGGOLiN.git
cd PPanGGOLiN

2. Install Dependencies

Ensure you have all the necessary dependencies installed. Refer to the installation instructions above for guidance on installing dependencies.

3. Install PPanGGOLiN

Once dependencies are installed, proceed to install PPanGGOLiN using pip:

pip install .