Installation instructions

The simplest way to install the APyT package is via the official PyPI repository:

pip3 install apyt

This command automatically installs all required dependencies. After installation, you can verify the setup and test the package using the included example dataset by following the example usage section.

Note

It is recommended to create a Python virtual environment before installing APyT. This ensures that dependencies are isolated from your system Python installation and prevents potential version conflicts with other packages.

You can create and activate a virtual environment as follows:

On Linux / macOS:

python3 -m venv --prompt APyT apyt-env
source apyt-env/bin/activate

On Windows (Command Prompt):

python -m venv --prompt APyT apyt-env
apyt-env\Scripts\activate

Attention

Do not install Python from the Microsoft Store. There are known issues related to sandboxing, particularly the redirection of AppData, which may interfere with the configuration file location of the APyT package. Instead, install Python on Microsoft Windows using the official Python installer.