Skip to content

Commit

Permalink
Update feature list
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Jul 15, 2023
1 parent a53460a commit 66c51c1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 20 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ A Python package for software-defined radio.
## Features

- Filters:
- Infinite impulse response filter (`sdr.IIR`)
- Arbitrary resamplers:
- Farrow resampler (`sdr.FarrowResampler`)
- Signal generators:
- Numerically-controlled oscillator (`sdr.NCO`)
- Direct digital synthesizer (`sdr.DDS`)
- Phase-locked loops:
- Loop filter (`sdr.LoopFilter`)
- Closed-loop PLL analysis (`sdr.ClosedLoopPLL`)
- Filters: `sdr.IIR`
- Pulse shapes: `sdr.raised_cosine`, `sdr.root_raised_cosine`
- Arbitrary resamplers: `sdr.FarrowResampler`
- Phase-locked loops: `sdr.NCO`, `sdr.DDS`, `sdr.LoopFilter`, `sdr.ClosedLoopPLL`
- Data manipulation: `sdr.pack`, `sdr.unpack`
- Plotting utilities: `sdr.plot.time_domain`, `sdr.plot.filter`, `sdr.plot.frequency_response`,
`sdr.plot.group_delay`, `sdr.plot.impulse_response`, `sdr.plot.step_response`,
`sdr.plot.zeros_poles`

## Documentation

Expand Down
18 changes: 8 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,14 @@ The :obj:`sdr` library is a Python 3 package for software-defined radio (SDR) ap
Features
--------

- Filters:
- Infinite impulse response filter (:obj:`sdr.IIR`)
- Arbitrary resamplers:
- Farrow resampler (:obj:`sdr.FarrowResampler`)
- Signal generators:
- Numerically-controlled oscillator (:obj:`sdr.NCO`)
- Direct digital synthesizer (:obj:`sdr.DDS`)
- Phase-locked loops:
- Loop filter (:obj:`sdr.LoopFilter`)
- Closed-loop PLL analysis (:obj:`sdr.ClosedLoopPLL`)
- Filters: :obj:`sdr.IIR`
- Pulse shapes: :obj:`sdr.raised_cosine`, :obj:`sdr.root_raised_cosine`
- Arbitrary resamplers: :obj:`sdr.FarrowResampler`
- Phase-locked loops: :obj:`sdr.NCO`, :obj:`sdr.DDS`, :obj:`sdr.LoopFilter`, :obj:`sdr.ClosedLoopPLL`
- Data manipulation: :obj:`sdr.pack`, :obj:`sdr.unpack`
- Plotting utilities: :obj:`sdr.plot.time_domain`, :obj:`sdr.plot.filter`, :obj:`sdr.plot.frequency_response`,
:obj:`sdr.plot.group_delay`, :obj:`sdr.plot.impulse_response`, :obj:`sdr.plot.step_response`,
:obj:`sdr.plot.zeros_poles`

.. toctree::
:caption: Examples
Expand Down

0 comments on commit 66c51c1

Please sign in to comment.