Komm
A Python library for communication systems.
Welcome to Komm!
Komm is an open-source library for Python 3 providing tools for analysis and simulation of analog and digital communication systems. This project is inspired by many other communication systems libraries, such as MATLAB® Communications System Toolbox™, GNU Radio, CommPy, and SageMath. Komm is licensed under the GNU General Public License v3.0.
For library reference, please check the project's website.
[!WARNING] Please be advised that this project is currently under development. As such, there may be changes to the project's codebase, including the API.
Installation
Before you start, make sure you have Python (version 3.11 or later) installed. Also, you may want to create and activate a virtual environment first:
python3 -m venv .venv
source .venv/bin/activate
From PyPI
pip install komm
From GitHub
pip install git+https://github.com/rwnobrega/komm.git@main
Development
First, clone the repository:
git clone https://github.com/rwnobrega/komm
cd komm
Then, if you haven't already, create and activate a virtual environment as before.
Next, install the development dependencies. For example, using pip:
pip install -e .[lint,test,doc,debug,demo]
Testing
The test suite is written using the pytest framework. To run the tests, execute:
pytest
Documentation
The documentation is built using MkDocs with the Material for MkDocs theme. To serve the documentation locally, run:
mkdocs serve
Run demos
There are some demos available in the demo directory. They are written using Streamlit. To run them, execute:
streamlit run demo/index.py
Changelog
See the CHANGELOG.md.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file komm-0.32.0.tar.gz.
File metadata
- Download URL: komm-0.32.0.tar.gz
- Upload date:
- Size: 129.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae4fdd9e3be59175b2367f81d26aedbcc69ed67be2712bd02af48719489f0f1f
|
|
| MD5 |
d9116ae10c9399086ee5975c9efc1240
|
|
| BLAKE2b-256 |
dbb28958fd622237fd848838986da2d421f20f3dbbac4e5f9ed4d9f758bfaf99
|
File details
Details for the file komm-0.32.0-py3-none-any.whl.
File metadata
- Download URL: komm-0.32.0-py3-none-any.whl
- Upload date:
- Size: 203.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8c8601e6c5a3fb0ef9a03ccca7ff57c9577a5ad7a3db4300feac96866ea5ef1
|
|
| MD5 |
8505a869f61907b311d9bda481751571
|
|
| BLAKE2b-256 |
314990d1e964e83fa8bd35f8369bd3da0df435f2cc2d40f324280b20cce686a3
|
