Skip to content

Latest commit

 

History

History
149 lines (103 loc) · 3.11 KB

INSTALL.md

File metadata and controls

149 lines (103 loc) · 3.11 KB
Raw

Installing Friture

Binary releases

Get the latest binary releases for Windows, macOS and Linux on the Releases page.

Running Friture from source on Linux

The following steps can be used to prepare a development environment for Friture on Ubuntu.

Prerequisite: a 64 bits Linux installation (PyQt5 wheels for Linux are only available for 64 bits).

This has been tested in a Virtualbox image for Ubuntu Trusty 16.04 LTS 64 bits from osboxes.org. The following custom settings have been set on the VM: increase video memory, enable 3d acceleration, enable audio input, install guest addition, add user to vboxsf (for file sharing with the host), keyboard layout setup.

  1. Install git
sudo apt-get update
sudo apt-get install -y git
  1. Install portaudio (used for audio IO in Friture)
sudo apt-get install -y libportaudio2
  1. Install python 3.11 and related build tools
sudo apt-get install -y python3.11-dev
  1. Clone the repository
git clone https://github.com/tlecomte/friture.git
cd friture
  1. Optional: switch to a specific branch
git fetch
git checkout origin/<branchName>
  1. Update pip, setuptools and virtualenv
sudo python3.11 -m pip install --upgrade pip
sudo pip3.11 install --upgrade setuptools
sudo pip3.11 install --upgrade virtualenv
  1. Create a virtualenv and activate it
virtualenv  -p /usr/bin/python3.11 buildenv
source ./buildenv/bin/activate
  1. Install Friture dependencies (PyQt5, etc.)
pip3.11 install .[dev]
  1. Build Cython extensions
python3.11 setup.py build_ext --inplace
  1. Run Friture
python3.11 main.py

Running Friture from source on Windows

The following steps can be used to prepare a development environment for Friture on Windows.

  1. Clone this repo

  2. Install chocolatey from https://chocolatey.org/install

  3. Install Python and Microsoft Visual Studio C++ Build Tools, required to build Friture. With chocolatey, in an administrator terminal:

choco install -y choco\packages.config

Watch out for a message indicating that a reboot is necessary.

The next commands do not need to be run in an administrator terminal.

  1. Make sure pip is up-to-date:
python -m pip install --upgrade pip
  1. Install virtualenv:
pip install -U virtualenv
  1. Build a virtualenv:
virtualenv buildenv
  1. Activate the virtualenv
.\buildenv\Scripts\activate
  1. Install dependencies
pip install .[dev]
  1. Build Cython extensions
python setup.py build_ext --inplace
  1. Run Friture
python main.py

Dependencies

See pyproject.toml

UI and resource files

If friture.ui or resource.qrc are changed, the corresponding python files need to be rebuilt:

pyuic5 ui/friture.ui --from-imports > friture/ui_friture.py
pyuic5 ui/settings.ui --from-imports > friture/ui_settings.py
pyrcc5 resources/friture.qrc -o friture/friture_rc.py

Filters parameters

The filters parameters are precomputed in a file called generated_filters.py. To rebuild this file, run the script named filter_design.py.