Documentation

DocumentationInstallation

Installation Guide

Get AlignAIR up and running in minutes with our step-by-step installation guide.

Choose Your Installation Method

Docker Installation

Recommended

The easiest way to run AlignAIR. Everything is pre-configured and ready to use.

No manual setup required

Consistent environment across platforms

Pre-trained models included

Local Installation

Advanced

Install AlignAIR directly on your system. Recommended for developers and advanced users.

Full control over environment

Easier integration with workflows

Requires manual configuration

Docker Installation Steps

Verify Docker

Make sure Docker is installed and running:

docker --version

Expected: Docker version 20.10+

Pull AlignAIR Image

Download the latest AlignAIR image:

docker pull thomask90/alignair:latest

This may take a few minutes depending on your connection

Prepare Data Directory

Create directories for your data:

mkdir -p ~/alignair-data/input ~/alignair-data/output

Place your input files in ~/alignair-data/input/

Run Container

Start AlignAIR with volume mounting:

docker run -it --rm -v ~/alignair-data:/data thomask90/alignair:latest

You should see the AlignAIR command prompt

System Requirements

Recommended Setup

NVIDIA GPU

CUDA 11+ support for optimal performance

16GB+ RAM

For large batch processing

10GB+ Storage

For models and datasets

Minimum Requirements

Multi-core CPU

CPU mode available (slower)

8GB+ RAM

For basic processing

5GB+ Storage

Minimum free space

Local Installation (Advanced)

Prerequisites

Python 3.8+

python --version

Git

git --version

Installation Steps

1. Clone the repository:

git clone https://github.com/MuteJester/AlignAIR.git

2. Navigate to directory and install dependencies:

cd AlignAIR pip install -r requirements.txt

3. Verify installation:

python app.py --help

⚠️ Note for Advanced Users

This method requires a properly configured Python environment and is recommended for developers only. You'll need to manually download model weights and configure paths.

What's Next?

Usage Guide

Learn how to run AlignAIR with different parameters and configurations.

Technical Details

Dive deep into the architecture and algorithms behind AlignAIR.

GitHub Repository

Access the source code, report issues, and contribute to the project.

🎉 Ready to Get Started!

AlignAIR is now installed and ready to process your sequence data. Check out the usage guide to run your first analysis.

Start Using AlignAIR

Back to

Docs Home

Star on GitHub Report Issue

Usage

Terms•License•Open Source