pyfda is a tool written in Python / Qt for analyzing and designing discrete time filters with a user-friendly GUI. Fixpoint filter implementations (for some filter types) can be simulated and tested for overflow and quantization behaviour in the time and frequency domain.
pyfda source code ist distributed under a permissive MIT license, binaries / bundles come with a GPLv3 license due to bundled components with stricter licenses.
For details, see INSTALLATION.md.
Binaries can be downloaded under Releases for versioned releases and for a latest release, automatically created for each push to the main branch.
Self-extracting archives for 64 bit Windows, OS X and Ubuntu Linux are created with pyInstaller. The archives self-extract to a temporary directory that is automatically deleted when pyfda is terminated (except when it crashes), they don't modify the system except for two ASCII configuration files and a log file. No additional software / libraries need to be installed, there is no interaction with existing python installations and you can simply overwrite or delete the executables when updating. After downloading the Linux archive, you need to make it executable (chmod 775 pyfda_linux
).
Binaries for Linux are created as Flatpaks as well (currently broken) which can also be downloaded from Flathub (also broken). Many Linux distros have built-in flatpak support, for others it's easy to install with e.g. sudo apt install flatpak
. For details check the Flatpak home page.
Python 3.8 and above is supported, there is only one version of pyfda for all operating systems at PyPI. As pyfda is a pure Python project (no compilation required), you can install pyfda the usual way, required libraries are downloaded automatically if missing:
> pip install pyfda
Upgrade:
> pip install pyfda -U
Uninstall:
> pip uninstall pyfda
A pip installation creates a start script pyfdax
in <python>/Scripts
which should be in your path. So, simply start pyfda using
> pyfdax
The following libraries are required and installed automatically by pip when missing.
Optional libraries:
If you're working with Anaconda's packet manager conda, there is a recipe for pyfda on conda-forge
since July 2023:
> conda install --channel=conda-forge pyfda
You should install pyfda into a new environment to avoid unwanted interaction with other installations.
If you want to contribute to pyfda (great idea!), fork the latest version from https://github.com/chipmuenk/pyfda.git and create a local copy using
> git clone https://github.com/<your_username>pyfda
This command creates a new folder pyfda
at your current directory level and copies the complete pyfda project into it. This Github tutorial provides a good starting point for working with git repos.
pyfda can then be installed (i.e. creating local config files and the pyfdax
starter script) from local files using
> pip install -e <YOUR_PATH_TO_PYFDA_setup.py>
Now you can edit the code and test it. If you're happy with it, push it to your repo and create a Pull Request so that the code can be reviewed and merged into the chipmuenk/pyfda
repo.
For details on how to publish pyfda to PyPI, how to create pyInstaller and Flatpak bundles, see BUILDING.md.
The location of the following two configuration files (copied to user space) can be checked via the tab Files -> About
:
pyfda_log.conf
pyfda.conf
. You can also define one or more user directories containing your own widgets and / or filters.Layout and some default paths can be customized using the file pyfda/pyfda_rc.py
, at the moment you have to edit that file at its original location.
Fixed()
class or on the
Amaranth hardware description
language.exp(-pi/4 * 1j)
using numexpr syntaxabs(sin(2*pi*n*f1))
using numexpr syntax and the UI.For details, see CHANGELOG.md.