Skip to content

Commit

Permalink
Add more detail to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Jul 9, 2023
1 parent a095849 commit d46bad5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

A Python package for software-defined radio.

> Enjoying the library? Give us a :star: on [GitHub](https://github.com/mhostetter/sdr)!
## Features

- Filters:
Expand All @@ -31,3 +33,20 @@ A Python package for software-defined radio.
- Phase-locked loops:
- Loop filter (`sdr.LoopFilter`)
- Closed-loop PLL analysis (`sdr.ClosedLoopPLL`)

## Documentation

The documentation for `sdr` is located at https://mhostetter.github.io/sdr/latest/.

## Install the package

The latest version of `sdr` can be installed from [PyPI](https://pypi.org/project/sdr/) using `pip`.

```console
$ python3 -m pip install sdr
```

## Examples

There are detailed examples published at https://mhostetter.github.io/sdr/latest/examples/iir-filter/.
The Jupyter notebooks behind the examples are available for experimentation in `docs/examples/`.

0 comments on commit d46bad5

Please sign in to comment.