Dependencies and Requirements - Ktiseos-Nyx/Dataset-Tools GitHub Wiki

Requirements

To set up and run Dataset-Tools, you'll need Python, Git, and the necessary Python packages (dependencies), primarily PyQt6.

1. Python

  • Minimum Version: Python 3.10 or newer is required. Older versions may not be compatible with the installation process or the tool's features.
  • Installation:
  • Package Management (Optional but Recommended):
    • Consider using uv (astral-sh/uv). uv is a fast, Rust-based package installer and resolver, compatible with Linux, Windows, and macOS. It can significantly speed up the installation of dependencies.

2. Git

Git is needed to clone the repository.

3. Python Dependencies (including PyQt6)

The application relies on several Python packages, with PyQt6 being a core component for the graphical interface. These are typically installed using pip (or uv) by running pip install -r requirements.txt from the cloned repository directory.

Important Notes for Linux/Debian/Ubuntu Users regarding PyQt6:

  • Supported Ubuntu Versions: PyQt6 and its system-level dependencies are generally included by default or are easily installable via apt on:
    • Ubuntu 20.04 LTS (Focal Fossa)
    • Ubuntu 22.04 LTS (Jammy Jellyfish)
    • Ubuntu 23.04 (Lunar Lobster) and newer non-LTS/LTS releases.
  • Other Linux Distributions: If your distribution is not listed above, it might already include the necessary components for PyQt6.
  • Installation Issues: Some Linux systems, particularly older or differently configured ones, might not install all required system libraries for PyQt6 automatically when you use pip. If you encounter issues like "missing libxcb" or similar:
    1. Try installing system dependencies: 
      sudo apt update
sudo apt install libxcb-xinerama0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 libxcb-shape0 libxkbcommon-x11-0 libgl1-mesa-glx
      (Note: Package names might vary slightly between distributions. The list above is common for Debian/Ubuntu based systems.)
    2. Refer to the "Advanced Installation Details for PyQt6" section in this wiki (if available) or search for instructions specific to your Linux distribution for installing PyQt6 system dependencies.
    3. If problems persist, please open an issue on our GitHub repository.

Troubleshooting:

  • If you encounter any problems with installing requirements, especially on Ubuntu or other Linux distributions, please check the specific notes above or let us know by creating an issue in the GitHub repository's "Issues" section.