Installation

HappyFeat is available on PyPI and GitHub.

Warning

Using a virtual environment (e.g. Miniconda or venv) is highly recommended!

Warning

As of version 0.3.0, HappyFeat works with Python 3.12.8.

Using different versions may results in crashes or unhandled errors.

Packaged version

Releases are published on https://github.com/Inria-NERV/happyFeat/releases

python -m pip install happyfeat

Development version from Github

Clone the project to a local directory:

• SSH: git clone git@github.com:Inria-NERV/happyFeat.git
• HTTPS: git clone https://github.com/Inria-NERV/happyFeat

Set up the virtual environment & install the requirements.
With python venv & pip:

python -m venv <yourEnvName>
./<yourEnvName>/bin/activate
python -m pip install -r requirements.txt

With conda/miniconda:

conda env create --name <yourEnvName> -f conda_env.yaml
conda activate <yourEnvName>

If you would like to use Timeflux with Happyfeat:

python -m pip install timeflux
python -m pip install timeflux_dsp

Warning

As of today, HappyFeat requires OpenViBE 3.6.0 or Timeflux to run.

Note

Packaging with PyPI and installer .exe file for Windows coming soon...