Installation

Using your favourite package manager

PsyBee can be installed from PyPI using pip, from Conda using conda, or from GitHub using pip. If you instal from PyPI or Conda, a precompiled binary wheel will be downloaded (if available for your platform). If you install from GitHub, the library will be compiled from source. This is also true if there are no precompiled binaries available for your platform. All external dependencies are included in the wheel, so you usually don't need to worry about installing them separately.

It is generally recommended to install PsyBee into a virtual environment. This can be done using python -m venv or conda. Please refer to the Python documentation or the Conda documentation for more information.

Note

We currently provide precompiled binaries for Windows (x64), Mac (arm64), Linux (x64), iOS (arm64), and Android (arm64). If you want to compile the library from source, you will need a number of dependencies. Please refer to the Rust installation guide for more information.

PyPI Conda GitHub

pip install psybee

conda install -c conda-forge psybee

pip install git+https://github.com/marcpabst/psybee/

Thats it - you're all set to write your first PsyBee experiment!

Using pyproject.toml

Alternatively, if you're using Briefcase or another packaging tool that supports pyproject.toml, you can add the following to your pyproject.toml file. Note that Poetry has a different format for specifying dependencies, amd you will need to refer to the Poetry documentation for more information.

[project]
dependencies = [
    "psybee"
]

Using Cargo

The psybee crate (Rust) can also be installed from Crates.io using cargo, or from GitHub using cargo. Hoewever, there is currently limited documentation available for the Rust API. The only external dependency you will need is gstreamer-1.0 (with the execption of iOS, Android, and the web, where gstreamer-assocated features are disabled).

cargo add PsyBee