Skip to main content

FT8 Decoding and Encoding in Python with test/loopback code

Project description

PyFT8 PyPI Downloads

FT8 Decoding and Encoding in Python with CLI and research code

This repository contains Python code to decode and encode (all the way to audio) FT8, plus a minimal Command Line Interface for reception, and a nascent set of research code. Untitled presentation

MiniPyFT8

As well as the full PyFT8, which gets between ~70% and 100% of WSJT-x decodes (see 'Performance' below), I've also included a novelty/experimental 'MiniPyFT8_noLDPC'. This is a single-file, ~300 line, minimised Python decoder that decodes around 50% of WSJT-x decodes and might be suitable for porting into C++ for very small hardware decoders.

Motivation

This started out as me thinking "How hard can it be, really?" after some frustration with Windows moving sound devices around and wanting to get a minimal decoder running that I can fully control.

I didn’t want to produce yet another port of the original Fortran / C into another language: instead I wanted to see how far I could get following audio -> spectrogram -> symbols -> bits -> error correction without resyncs and special treatments, writing my own code from scratch as far as possible. Also this has been, more than I expected, an exercise in writing Python ‘Pythonically’ for speed, which means absolutely not duplicating the big nested loops of Fortran and C. It also means writing code that is wide and short rather than thin and long, which suits my thinking style perfectly!

Uses

I use this code for my own hobby-level reseearch into FT8 decoding and Python coding techniques, and I'm also building a browser-GUI station controller (image below) which has an FT8 transceiver integrated within it. You can see that here but note that it's focussed on my station, i.e. ICOM-IC-7100 with an Arduino controlling antenna switching and magloop tuning.

station-gui

Performance Compared with FT8_lib and WSJT-x

The image below shows the number of decodes from PyFT8 and FT8_lib both as a percentage of WSJT-x V2.7.0 running in NORM mode, for a set of wav files copied from FT8_lib's 20m_busy tests.

batch_tests_offline_20m_busy

Live performance compared to WSJT-x

On a quiet band with good signals, PyFT-8 typically gets 70% or 80% and often 100% of WSJT-x decodes. On a crowded band (e.g. 20m plot below), PyFT8 performs less well. WSJT-x uses signal subtraction to improve performance with overlapping signals. PyFT8 can decode overlapping signals surprisingly well, but not as well as WSJT-x. Even so, this is a snapshot of performance on 20m at lunchtime in the UK winter (W = WSJTX, P = Pyft8, B = Both):

image

Installation

This repository is usually a little ahead of the releases I send to PyPI, but you can pip install it from there and just use the Command Line Interface (which can also transmit individual messages) if you want to.

cmd

Install using:

pip install PyFT8

And to run, use the following (more info here)

PyFT8_cli "Keyword1, Keyword2" [-c][-v]

* where keywords identify the sound device - partial match is fine - and -c = concise, -v = verbose

Otherwise, please download or browse the code, or fork the repo and play with it! If you do fork it, please check back here as I'm constantly (as of Jan 2026) rewriting and improving.

Limitations

In pursuit of tight code, I've concentrated on core standard messages, leaving out some of the less-used features. The receive part of the code doesn't (yet) have the full capability of the advanced decoders used in WSJT-x, and so gets only about 60% of the decodes that WSJT-x gets, depending on band conditions (on a quiet band with only good signals PyFT8 will get close to 100%).

Acknowledgements

This project implements a decoder for the FT8 digital mode. FT8 was developed by Joe Taylor, K1JT, Steve Franke, K9AN, and others as part of the WSJT-X project. Protocol details are based on information publicly described by the WSJT-X authors and in related open documentation.

Some constants and tables (e.g. Costas synchronization sequence, LDPC structure, message packing scheme) are derived from the publicly available WSJT-X source code and FT8 protocol descriptions. Original WSJT-X source is © the WSJT Development Group and distributed under the GNU General Public License v3 (GPL-3.0), hence the use of GPL-3.0 in this repository.

Also thanks to Robert Morris for basicft8(*1) - the first code I properly read when I was wondering whether to start this journey. (*1 note: applies to FT8 pre V2)

Useful resources:

WSJTx - focussed:

Other FT8 decoding repos:

FT8 decoding explorations / explanations

FT8 decoding in hardware

FT8 encode/decode simulators:

Browser-based decoder/encoders

<script data-goatcounter="https://g1ojs-github.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyft8-1.4.0.tar.gz (13.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyft8-1.4.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file pyft8-1.4.0.tar.gz.

File metadata

  • Download URL: pyft8-1.4.0.tar.gz
  • Upload date:
  • Size: 13.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for pyft8-1.4.0.tar.gz
Algorithm Hash digest
SHA256 5e7411918442ce27f66caffc43dcf80e9c8f3fb73251c18ea00c81efd7630bb2
MD5 15d82fdee8cd29ef66756e790b1cbd18
BLAKE2b-256 401a5db87231ae7f4a909644ab6e4dc0f358176ea25c21b3e24b824a945a7cc0

See more details on using hashes here.

File details

Details for the file pyft8-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyft8-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for pyft8-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 777eed88bc260318df0189027a73327b937ee5fdd0198e65b580009398eba738
MD5 40b44ad3726123891203ed4ee82c5862
BLAKE2b-256 afd70381326a78b654265ba2ac3ce8a225832e0ed73be97643ed0f3113b00219

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page