Skip to content

Commit

Permalink
Update the feature list
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Jul 23, 2023
1 parent 0377fa6 commit 4621987
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,21 @@ in `sdr`, please open an issue on GitHub.
- Filters: `sdr.FIR`, `sdr.IIR`
- Pulse shapes: `sdr.raised_cosine()`, `sdr.root_raised_cosine()`, `sdr.gaussian()`
- Arbitrary resamplers: `sdr.FarrowResampler`
- Modulation: `sdr.PSK`
- Modulation: `sdr.PSK`, `sdr.gray_code()`
- Phase-locked loops: `sdr.NCO`, `sdr.DDS`, `sdr.LoopFilter`, `sdr.ClosedLoopPLL`
- Impairments: `sdr.awgn()`
- Impairments: `sdr.awgn()`, `sdr.iq_imbalance()`
- Measurement: `sdr.energy()`, `sdr.peak_power()`, `sdr.average_power()`, `sdr.peak_voltage()`,
`sdr.rms_voltage()`, `sdr.papr()`, `sdr.crest_factor()`
- Data manipulation: `sdr.pack()`, `sdr.unpack()`, `sdr.hexdump()`
- Channel models: `sdr.bsc()`, `sdr.bec()`, `sdr.dmc()`
- Link budgets: `sdr.fspl()`
- Link budgets: `sdr.awgn_capacity()`, `sdr.bsc_capacity()`, `sdr.bec_capacity()`,
`sdr.fspl()`, `sdr.parabolic_antenna()`
- Probability: `sdr.Q()`, `sdr.Qinv()`
- Plotting utilities: `sdr.plot.time_domain()`, `sdr.plot.periodogram()`, `sdr.plot.spectrogram()`
`sdr.plot.filter()`, `sdr.plot.frequency_response`, `sdr.plot.group_delay()`,
`sdr.plot.impulse_response()`, `sdr.plot.step_response()`, `sdr.plot.zeros_poles()`
`sdr.plot.filter()`, `sdr.plot.frequency_response`, `sdr.plot.phase_response()`,
`sdr.plot.phase_delay()`, `sdr.plot.group_delay()`,
`sdr.plot.impulse_response()`, `sdr.plot.step_response()`,
`sdr.plot.zeros_poles()`

## Documentation

Expand Down
13 changes: 8 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,21 @@ Features
- Filters: :class:`sdr.FIR`, :class:`sdr.IIR`
- Pulse shapes: :func:`sdr.raised_cosine()`, :func:`sdr.root_raised_cosine()`, :func:`sdr.gaussian()`
- Arbitrary resamplers: :class:`sdr.FarrowResampler`
- Modulation: :class:`sdr.PSK`
- Modulation: :class:`sdr.PSK`, :func:`sdr.gray_code()`
- Phase-locked loops: :class:`sdr.NCO`, :class:`sdr.DDS`, :class:`sdr.LoopFilter`, :class:`sdr.ClosedLoopPLL`
- Impairments: :func:`sdr.awgn()`
- Impairments: :func:`sdr.awgn()`, :func:`sdr.iq_imbalance()`
- Measurement: :func:`sdr.energy()`, :func:`sdr.peak_power()`, :func:`sdr.average_power()`, :func:`sdr.peak_voltage()`,
:func:`sdr.rms_voltage()`, :func:`sdr.papr()`, :func:`sdr.crest_factor()`
- Data manipulation: :func:`sdr.pack()`, :func:`sdr.unpack()`, :func:`sdr.hexdump()`
- Channel models: :func:`sdr.bsc()`, :func:`sdr.bec()`, :func:`sdr.dmc()`
- Link budgets: :func:`sdr.awgn_capacity()`, :func:`sdr.bsc_capacity()`, :func:`sdr.bec_capacity()`,
:func:`sdr.fspl()`, :func:`sdr.parabolic_antenna()`
- Probability: :func:`sdr.Q()`, :func:`sdr.Qinv()`
- Link budgets: :func:`sdr.fspl()`
- Plotting utilities: :func:`sdr.plot.time_domain()`, :func:`sdr.plot.periodogram()`, :func:`sdr.plot.spectrogram()`
:func:`sdr.plot.filter()`, :func:`sdr.plot.frequency_response`, :func:`sdr.plot.group_delay()`,
:func:`sdr.plot.impulse_response()`, :func:`sdr.plot.step_response()`, :func:`sdr.plot.zeros_poles()`
:func:`sdr.plot.filter()`, :func:`sdr.plot.frequency_response`, :func:`sdr.plot.phase_response()`,
:func:`sdr.plot.phase_delay()`, :func:`sdr.plot.group_delay()`,
:func:`sdr.plot.impulse_response()`, :func:`sdr.plot.step_response()`,
:func:`sdr.plot.zeros_poles()`

.. toctree::
:caption: Examples
Expand Down

0 comments on commit 4621987

Please sign in to comment.