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
Release files for komm 0.33.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| komm-0.33.0.tar.gz | 133.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| komm-0.33.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 341.9 kB
Release files / komm-0.33.0.tar.gz
| Download URL | komm-0.33.0.tar.gz |
|---|---|
| Size | 133.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
551ce39a1d40c0d391c67f1c5d76c920d2434e429806786d0bed84e2b5b7e19d
|
|
BLAKE2b-256 checksum How to use checksums |
827b2e96a9df6733fe76f6ecea1ca45f116e533b3367940856e5670a258c8608
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / komm-0.33.0-py3-none-any.whl
| Download URL | komm-0.33.0-py3-none-any.whl |
|---|---|
| Size | 208.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
87b911f05dd3938a25ad5fae1d838a99e56a343d56ed850f32f561b3e0673495
|
|
BLAKE2b-256 checksum How to use checksums |
955b0fcb017bab5929a46aeac9cb91944ab29b33e27efc91309b5580791ea848
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
