Installation

Requirements

Titli requires Python 3.10 or higher.

Dependencies

  • scapy

  • numpy

  • pandas

  • matplotlib

  • scikit-learn

  • scipy

  • tqdm

  • torch

  • torchvision

Installing from PyPI

The easiest way to install Titli is using pip:

pip install titli

This will install Titli and all required dependencies except PyTorch.

Installing PyTorch

For optimal performance, especially if you have GPU support, it’s recommended to install PyTorch separately according to your system configuration. Visit the PyTorch website for installation instructions specific to your platform.

For example, to install PyTorch with CUDA support:

# For CUDA 11.8
pip install torch torchvision --index-url https://download.pytorch.org/whl/cu118

# For CPU only
pip install torch torchvision

Installing from Source

To install the latest development version from source:

git clone https://github.com/spg-iitd/titli.git
cd titli
pip install -e .

This installs Titli in editable mode, allowing you to modify the source code and see changes immediately.

Verifying Installation

To verify that Titli is installed correctly, you can run:

import titli
from titli.fe import AfterImage
from titli.ids import KitNET

print("Titli installed successfully!")

If no errors occur, the installation was successful.

Development Installation

If you plan to contribute to Titli, install the development dependencies:

git clone https://github.com/spg-iitd/titli.git
cd titli
pip install -e ".[dev]"

This includes additional tools for testing, linting, and building documentation.