Skip to content

Installation

Aegear can be used either as a Python library for advanced workflows or as a standalone graphical user interface (GUI) application. Choose the method that best suits your needs.

Pre-built standalone binaries for Windows and macOS are available on the GitHub Releases page. These executables are packaged using PyInstaller and do not require installation.

🖥️ Windows

  1. Download the latest Windows binary:
  2. aegear-gui-v0.4.1-win64-cpu.exe
  3. Place the downloaded file in a folder of your choice.
  4. Double-click to run Aegear directly. No installation is required.

⚠️ CUDA Support:
The Windows binary includes CPU-only PyTorch.
To use GPU acceleration, install Aegear from source (see below).

🍏 macOS

  1. Download the macOS (Apple Silicon) binary:
  2. aegear-gui-v0.4.1-mac-arm64.zip
  3. Unzip the archive.
  4. Double-click the Aegear app to run it. You may need to right-click → Open on first launch to bypass Gatekeeper restrictions.

🔧 Python Library (For Developers)

If you want to use Aegear programmatically or with GPU support, install from source:

1. Clone the Repository

git clone https://github.com/ljubobratovicrelja/aegear.git
cd aegear

2. Install Dependencies

It’s recommended to use a virtual environment: 

python -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

pip install -e .

This installs Aegear in editable mode. If you plan to run training jobs (dataset downloads and WebDataset loaders), layer in the lightweight training dependencies: 

pip install -e .[train]

For full development (notebooks, visualization tooling, HPO, etc.) use the broader dev extra instead: 

pip install -e .[dev]

For CUDA-enabled Torch releases (currently supported runtime 12.8, PyTorch ≥2.9), add the extra index URL so pip installs GPU wheels rather than the CPU fallback: 

pip install -e .[train] --extra-index-url https://download.pytorch.org/whl/cu128
# or: pip install -e .[dev] --extra-index-url https://download.pytorch.org/whl/cu128

3. Launch the GUI

If you installed the Python package, you can launch the GUI directly: 

aegear-gui

📌 Requirements

Component Version
Python >=3.11
PyTorch >2.6
CUDA (optional) 12.4 (with cuda124 project installation)

📖 Documentation

For more details, see Usage and API Reference.