Installation¶

This page explains how to install MTD Explorer from the GitHub repository using the official installation script.

Before starting, review the system requirements.

Development version

MTD Explorer is under active development. Installation commands, database requirements, and output structures may change before the first stable release.

Install Git¶

Git is required to download the MTD Explorer source code and to keep the installation updated.

Check whether Git is already installed:

git --version

When Git is available, the command displays its installed version.

If Git is not installed, install it using the package manager of your Linux distribution.

Ubuntu and Linux Mint¶

sudo apt update
sudo apt install -y git

Confirm the installation:

git --version

Clone the MTD Explorer repository¶

After installing Git, download the MTD Explorer repository.

Using HTTPS¶

cd ~
git clone https://github.com/patrick-douglas/MTD-Explorer.git
cd MTD

HTTPS is the recommended method for users who have not configured an SSH key for GitHub.

Using SSH¶

Users with a GitHub SSH key already configured may use:

cd ~
git clone git@github.com:patrick-douglas/MTD-Explorer.git
cd MTD

Confirm that the repository was downloaded correctly:

git status
git log -1 --oneline

The installation commands in the following sections should be executed from inside the MTD Explorer repository directory.

Before running the installer¶

Before starting the installation, confirm that:

you are using a supported GNU/Linux system;
Git is installed;
the repository was cloned successfully;
the installation cache is located on a disk with enough free space;
the selected Miniconda path can be safely created or replaced;
you have a stable internet connection;
you have sudo access for installing system dependencies;
the installer is being run from an interactive terminal.

Check the current repository state with:

git status
git log -1 --oneline

Check available disk space with:

df -h

Check memory and CPU resources with:

free -h
nproc

Installer command¶

The MTD Explorer installer is executed through Install.sh.

Display the current command-line help with:

bash Install.sh -h

The general syntax is:

Install.sh -o <installation-cache> [options]

What the installer does¶

The installer performs the main steps required to prepare MTD Explorer for use.

In summary, it:

validates installer arguments and paths;
prepares a persistent installation cache;
installs Miniconda when needed;
creates the required Conda environments;
installs system, Python, R, and bioinformatics dependencies;
downloads and validates reference files;
prepares HUMAnN databases;
prepares Kraken2 taxonomy and microbial databases;
prepares the validated Virus-Host DB reference mirror;
records installation paths used by MTD Explorer;
leaves the installation ready for validation with MTD_check_installation.sh.

Always verify the installation

A completed installer run should always be followed by:

bash MTD_check_installation.sh --mode full

For clean installations, interrupted downloads, or cache transfers between computers, use:

bash MTD_check_installation.sh --mode deep

Required option¶

Installation cache¶

The -o option specifies the persistent installation cache:

-o PATH

This option is required.

The directory is created and populated automatically when it does not already exist. Files already present in a valid cache may be reused during subsequent or interrupted installations.

Example:

bash Install.sh \
  -o /home/user/MTD_install_cache

The cache may also be located on a separate mounted disk:

bash Install.sh \
  -o /path/to/large/storage/MTD_install_cache

Use an absolute path

An absolute cache path is recommended.

Correct:

/home/user/MTD_install_cache

Correct:

/media/user/storage/MTD_install_cache

Incorrect:

/home/user/~/MTD_install_cache

The ~ character is expanded only when it appears at the beginning of a shell path.

Installer options¶

Option	Argument	Description
`-o`	`PATH`	Persistent installation cache. This option is required.
`-p`	`PATH`	Miniconda installation directory. The default is `$HOME/miniconda3`.
`-k`	`INT`	Kraken2 k-mer length used when building databases.
`-m`	`INT`	Kraken2 minimizer length used when building databases.
`-s`	`INT`	Kraken2 minimizer-spaces value used when building databases.
`-r`	`INT`	Bracken read length. The default is `75`.
`-h`	—	Display the installer help message and exit.

Kraken2 database parameters

Most users should leave -k, -m, and -s unset.

These parameters alter how Kraken2 databases are built and should be changed only when there is a specific technical reason to use non-default database settings.

Standard installation¶

For a standard installation using the default Miniconda location and a Bracken read length of 75:

cd ~/MTD

bash Install.sh \
  -o /home/user/MTD_install_cache

Replace /home/user/MTD_install_cache with the desired cache location.

Custom Miniconda location¶

By default, Miniconda is installed at:

$HOME/miniconda3

A different location can be selected with -p:

bash Install.sh \
  -o /path/to/MTD_install_cache \
  -p /path/to/miniconda3

The selected parent directory must be writable by the current user.

Existing Miniconda installation¶

The installer automatically downloads and installs Miniconda.

If the selected Miniconda directory already exists, the installer displays a warning and requests explicit confirmation before permanently deleting that directory.

Existing Miniconda directory

Confirming the removal of an existing Miniconda directory permanently deletes the environments and packages stored inside it.

Before confirming:

verify that the displayed path is correct;
confirm that no important Conda environments are stored there;
back up anything that must be preserved.

Do not confirm the deletion when the installer displays an unexpected directory.

Bracken read length¶

The default Bracken read length is:

A different value can be selected using -r:

bash Install.sh \
  -o /path/to/MTD_install_cache \
  -r 100

The selected value should correspond to the read length intended for Bracken abundance estimation.

Changing this option affects the Bracken files generated during database preparation.

Save the installation log¶

The complete installer output should be saved, especially during clean installations or tests on a new computer.

bash Install.sh \
  -o /path/to/MTD_install_cache \
  2>&1 | tee MTD_installation.log

This displays the installation output in the terminal while also saving it to:

MTD_installation.log

For a timestamped log:

bash Install.sh \
  -o /path/to/MTD_install_cache \
  2>&1 | tee "MTD_installation_$(date +%Y%m%d_%H%M%S).log"

During installation¶

The installer may display status messages such as:

Status	Meaning
`INFO`	Describes the current installation step
`PASS`	A required step or validation completed successfully
`WARNING`	A non-fatal condition requires attention
`RETRY`	A failed operation is being attempted again
`ERROR`	A required operation failed

Large reference databases may require considerable download and processing time.

The installation cache should not be deleted after a successful installation. It can be reused when:

reinstalling MTD Explorer;
recovering from an interrupted installation;
installing the pipeline on another computer;
validating downloaded reference files;
avoiding repeated large downloads.

After installation¶

Do not begin a real analysis solely because Install.sh reached the end.

First, run the dedicated installation verification procedure described in Verify the installation.