Skip to content

INSTALL.md

Latest commit

 

History

History
107 lines (73 loc) · 2.6 KB

INSTALL.md

File metadata and controls

107 lines (73 loc) · 2.6 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 (PyQt6 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 uv (Python package manager)
curl -LsSf https://astral.sh/uv/install.sh | sh
  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. Create a virtual environment and install Friture dependencies (PyQt6, etc.)
uv sync
  1. Run Friture
uv run python 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 uv. 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. Create a virtual environment and install dependencies
uv sync

uv sync handles everything: it creates the virtual environment and installs all dependencies.

  1. Run Friture
uv run python main.py

Dependencies

See pyproject.toml

UI and resource files

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

uv run pyuic6 ui/settings.ui -o friture/ui_settings.py
uv run pyrcc6 resources/friture.qrc -o friture/friture_rc.py

Filters parameters

The filters parameters are precomputed in files called generated_filters.py (IIR coefficients) and generated_fft.py (precomputed FIR coefficients and FFT frequency responses). To rebuild these files, run:

uv run python friture/filter_design.py

Note: filter_design.py requires scipy to be installed.