pyfda
======
## Python Filter Design Analysis Tool
pyfda is a GUI based tool in Python / Qt for analysing and designing discrete time filters. Fixpoint implementations (for some filter types) can be simulated.
For more info see the [`Github Repo`](https://github.com/chipmuenk/pyfda) and the documentation at [readthedocs.org](https://pyfda.readthedocs.io/en/latest/).
## Prerequisites
* Python versions: **3.7 ... 3.11**
* All operating systems, no OS specific requirements.
* Libraries:
* **(Py)Qt5**
* **numpy**
* **scipy**
* **matplotlib**: **2.1** or higher
### Optional libraries:
* **docutils** for rich text in documentation
* **xlwt** and / or **XlsxWriter** for exporting filter coefficients as *.xls(x) files
## Installing pyfda
Self-executing archives are available for Windows and OS X at https://github.com/chipmuenk/pyfda/releases which do not require a Python installation. Under Linux, pyfda can be installed as a flatpak.
Otherwise, installation is straight forward: There is only one version of pyfda for all supported operating systems, no compilation is required:
### pip
Install from PyPI using
> pip install pyfda
or upgrade using
> pip install pyfda -U
or install locally using
> pip install -e <YOUR_PATH_TO_PYFDA>
where `<YOUR_PATH_TO_PYFDA>` specifies the path of `setup.py` without including `setup.py`.
In this case, you need to have a local copy of the pyfda project, preferrably obtained using git and `pip install` only creates the start script.
### setup.py
You could also download the zip file from Github and extract it to a directory of your choice. Install it either to your `<python>/Lib/site-packages` subdirectory using
> python setup.py install
or just create a link to where you have copied the python source files (for testing / development) using
> python setup.py develop
## Starting pyfda
In any case, the start script `pyfdax` has been created in `<python>/Scripts` which should be in your path. So, simply start pyfda using
> pyfdax
For development and debugging, you can also run pyfda using
In [1]: %run -m pyfda.pyfdax # IPython or
> python -m pyfda.pyfdax # plain python interpreter
All individual files from pyfda can be run using e.g.
In [2]: %run -m pyfda.input_widgets.input_pz # IPython or
> python -m pyfda.input_widgets.input_pz # plain python interpreter
## Customization
The location of the following two configuration files (copied to user space) can be checked via the tab `Files -> About`:
- Logging verbosity can be controlled via the file `pyfda_log.conf`
- Widgets and filters can be enabled / disabled via the file `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`, right now you have to edit that file at its original location.
Raw data
{
"_id": null,
"home_page": "https://github.com/chipmuenk/pyFDA",
"name": "pyfda",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "digital,discrete time,filter design,IIR,FIR,GUI",
"author": "Christian Muenker",
"author_email": "mail07@chipmuenk.de",
"download_url": "https://files.pythonhosted.org/packages/cb/06/37b405575b6fbb27bdf6ba80761cbdc19251d0580739093cd2f1b14dacbb/pyfda-0.8.4.tar.gz",
"platform": "any",
"description": "pyfda\n======\n## Python Filter Design Analysis Tool\n\npyfda is a GUI based tool in Python / Qt for analysing and designing discrete time filters. Fixpoint implementations (for some filter types) can be simulated. \n\nFor more info see the [`Github Repo`](https://github.com/chipmuenk/pyfda) and the documentation at [readthedocs.org](https://pyfda.readthedocs.io/en/latest/).\n\n \n\n## Prerequisites\n\n* Python versions: **3.7 ... 3.11**\n* All operating systems, no OS specific requirements.\n* Libraries:\n * **(Py)Qt5**\n * **numpy**\n * **scipy**\n * **matplotlib**: **2.1** or higher\n\n### Optional libraries:\n* **docutils** for rich text in documentation\n* **xlwt** and / or **XlsxWriter** for exporting filter coefficients as *.xls(x) files\n\n## Installing pyfda\nSelf-executing archives are available for Windows and OS X at https://github.com/chipmuenk/pyfda/releases which do not require a Python installation. Under Linux, pyfda can be installed as a flatpak. \n\nOtherwise, installation is straight forward: There is only one version of pyfda for all supported operating systems, no compilation is required:\n\n### pip\nInstall from PyPI using\n\n > pip install pyfda\n\nor upgrade using\n\n > pip install pyfda -U\n\t\nor install locally using\n\n > pip install -e <YOUR_PATH_TO_PYFDA>\n\t\nwhere `<YOUR_PATH_TO_PYFDA>` specifies the path of `setup.py` without including `setup.py`. \nIn this case, you need to have a local copy of the pyfda project, preferrably obtained using git and `pip install` only creates the start script.\n\n### setup.py \nYou could also download the zip file from Github and extract it to a directory of your choice. Install it either to your `<python>/Lib/site-packages` subdirectory using\n\n > python setup.py install\n\nor just create a link to where you have copied the python source files (for testing / development) using\n\n > python setup.py develop\n\n## Starting pyfda\nIn any case, the start script `pyfdax` has been created in `<python>/Scripts` which should be in your path. So, simply start pyfda using\n\n > pyfdax\n\nFor development and debugging, you can also run pyfda using\n\n In [1]: %run -m pyfda.pyfdax # IPython or\n > python -m pyfda.pyfdax # plain python interpreter\n \nAll individual files from pyfda can be run using e.g.\n\n In [2]: %run -m pyfda.input_widgets.input_pz # IPython or \n > python -m pyfda.input_widgets.input_pz # plain python interpreter\n \n## Customization\n\nThe location of the following two configuration files (copied to user space) can be checked via the tab `Files -> About`:\n\n- Logging verbosity can be controlled via the file `pyfda_log.conf` \n- Widgets and filters can be enabled / disabled via the file `pyfda.conf`. You can also define one or more user directories containing your own widgets and / or filters.\n\nLayout and some default paths can be customized using the file `pyfda/pyfda_rc.py`, right now you have to edit that file at its original location.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Design and analyse discrete time DSP filters with a user-friendly GUI tool. Fixpoint filters in time and frequency domain, too.",
"version": "0.8.4",
"project_urls": {
"Homepage": "https://github.com/chipmuenk/pyFDA"
},
"split_keywords": [
"digital",
"discrete time",
"filter design",
"iir",
"fir",
"gui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11586529544894c3fb7052a5a5db700918ca9ae4133bba74a8176abbaa11928e",
"md5": "70bd175af93787c4f7a5da033ae4c78a",
"sha256": "b8d5ba7d7d781142b411dfa278279ed30ea7b244027e790096230bd41c26b6a5"
},
"downloads": -1,
"filename": "pyfda-0.8.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70bd175af93787c4f7a5da033ae4c78a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 614949,
"upload_time": "2023-10-10T12:17:56",
"upload_time_iso_8601": "2023-10-10T12:17:56.605569Z",
"url": "https://files.pythonhosted.org/packages/11/58/6529544894c3fb7052a5a5db700918ca9ae4133bba74a8176abbaa11928e/pyfda-0.8.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb0637b405575b6fbb27bdf6ba80761cbdc19251d0580739093cd2f1b14dacbb",
"md5": "fc49ad0f85bc47bafb7361b599f34d73",
"sha256": "50da813e53492fa6cfc00d2d66533c896cd6d2681eb72e76fa3fc7338e7eb166"
},
"downloads": -1,
"filename": "pyfda-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "fc49ad0f85bc47bafb7361b599f34d73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 547721,
"upload_time": "2023-10-10T12:17:58",
"upload_time_iso_8601": "2023-10-10T12:17:58.237380Z",
"url": "https://files.pythonhosted.org/packages/cb/06/37b405575b6fbb27bdf6ba80761cbdc19251d0580739093cd2f1b14dacbb/pyfda-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-10 12:17:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chipmuenk",
"github_project": "pyFDA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pyfda"
}
JSON
