Skip to content

Part 0 Installation

Janne Järvikylä edited this page Jun 16, 2026 · 9 revisions

Prerequisites

  • Python 3.9+

All the following steps assumes that the Python is already installed and path / environment variables are properly set. Tested in Windows 10 / Windows 11 / Ubuntu 24.04.

These instruction steps are for command line / shell and does not cover how to do this in IDE (e.g. VS Code, PyCharm).


1. Create Python virtual environment

This step can be skipped if you have already set up virtual environment for your project or want to install aiphoria system-wide.

  1. Create new directory for your project (e.g. aiphoria_project)

    NOTE: The newly created directory is referred from now on as project directory

  2. Go to your newly created project
  3. Open terminal/command prompt and navigate to your project directory
  4. Create new Python virtual environment inside your project directory

NOTE: Last parameter (env) is the name of the directory where Python will install virtual environment and this can be changed to another name now if needed (e.g. name to reflect used python version)

python -m venv venv

NOTE: Python virtual environments let you keep projects clean and conflict-free. They isolate library dependencies so each project can use its own package versions without breaking others, make setups reproducible across machines, and simplify collaboration and deployment.

In short: fewer surprises, easier debugging, and happier developers.


2. Activate virtual environment

Activate the virtual environment inside your project directory by running following commands:

Windows:

venv\Scripts\activate.bat

Linux:

source venv/bin/activate

3. Install aiphoria package

aiphoria package can also be installed using the IDE package control features or manually from command line. These steps assume that the Python has already been installed and environment variables are properly set.

Here we install aiphoria from PyPI using the terminal/command prompt.

3.1. Install aiphoria from PyPi

Run the following commands in terminal/command prompt:

pip install aiphoria

3.2. (Optional method) Install aiphoria from GitHub

aiphoria can also be installed from GitHub using the pip.

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

In the next part we show how to use aiphoria.

Next part: Part 1 Usage

Clone this wiki locally