Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Changed the install/develop comments.  Corrected the setuptools usage from the command-line.
  • Loading branch information
cfelton committed Sep 18, 2015
1 parent 5ec99ae commit f03f3e5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,26 @@ The project builds only on standard python libraries, libraries from the scipy s
### Installing and starting pyFDA
Download the zip file and extract it to a directory of your choice. Install it either to your `<python>/Lib/site-packages` subdirectory using

python setup.py -install
>> python setup.py install

or run it where you have installed the python source files using (for testing / development)

python setup.py -develop
>> python setup.py develop

In both cases, start scripts `pyfda*` are created in `<python>/Scripts`.

For development, you can also run pyFDA using

%run -m pyfda.pyfda # IPython or
python -m pyfda.pyfda # plain python interpreter
In [1]: %run -m pyfda.pyfda # IPython or
>> python -m pyfda.pyfda # plain python interpreter

or files from pyFDA using e.g.

%run -m pyfda.input_widgets.input_pz # IPython or
python -m pyfda.input_widgets.input_pz # plain python interpreter
In [2]: %run -m pyfda.input_widgets.input_pz # IPython or
>> python -m pyfda.input_widgets.input_pz # plain python interpreter




### Why yet another filter design tool?
* **Education:** There is a very limited choice of user-friendly, license-free tools available to teach the influence of different filter design methods and specifications on time and frequency behaviour. It should be possible to run the tool without severe limitations also with the limited resolution of a beamer.
* **Show-off:** Demonstrate that Python is a potent tool for digital signal processing applications as well. The interfaces for textual filter design routines are a nightmare: linear vs. logarithmic specs, frequencies normalized w.r.t. to sampling or Nyquist frequency, -3 dB vs. -6 dB vs. band-edge frequencies ... (This is due to the different backgrounds and the history of filter design algorithms and not Python-specific.)
Expand Down

0 comments on commit f03f3e5

Please sign in to comment.