Skip to content

Installation

cleorf92 edited this page Sep 24, 2026 · 1 revision

Prerequisites

  • Python 3.10 or newer

These steps assume that Python is already installed and that it can be run from the terminal/command prompt. Tested on Windows 10, Windows 11, and Ubuntu 24.04.

The steps are for the terminal/command prompt. Most IDEs (for example VS Code or PyCharm) can do the same through their own menus.


1. Create a Python virtual environment

You can skip this step if you already have a virtual environment for your project, or if you want to install aiphoria system-wide.

  1. Create a new folder for your project (for example aiphoria_project). From now on this is called the project directory.
  2. Open a terminal/command prompt and go to your project directory.
  3. Create a virtual environment inside it:
python -m venv venv

The last word (venv) is the name of the folder where the environment is created. You can change it, for example to show the Python version.

NOTE: Virtual environments keep projects separate. Each project can use its own package versions without breaking the others, and your setup is easier to reproduce on another computer.


2. Activate the virtual environment

Windows:

venv\Scripts\activate.bat

Linux/macOS:

source venv/bin/activate

3. Install aiphoria

3.1 From PyPI (recommended)

pip install aiphoria

3.2 From GitHub (latest development version)

pip install git+https://github.com/EuropeanForestInstitute/aiphoria.git

3.3 Check the installation

pip show aiphoria

This shows the installed version. Then run the example to check that everything works: Quick start.


Next: Quick start

Clone this wiki locally