Skip to content
/ PyFT8 Public

FT8 Decoding and Encoding in Python with CLI and research code

License

Notifications You must be signed in to change notification settings

G1OJS/PyFT8

Repository files navigation

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

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!

My current aim is to push the low SNR performance whilst using only one time/frequency grid and no time-domain processing.

Code I'd like to highlight, all in 100% Python:

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

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, 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. The plots below show real world performance on 10m and 20m respectively over lunchtime, with relatively many signals.

20m lunchtime hanning window 4persymb 2pertone 10m lunchtime hanning window 4persymb 2pertone

I have been using the file "210703_133430.wav" (third plot above) as a reference. In NORM mode, WSJT-x gets 19 decodes. WSJT-x in FAST mode gets 14 decodes, PyFT8 gets 12, and FT8_lib gets 8. The specific decodes are shown in the table below.

image

However, a single wav file with a single FT8 cycle is not sufficient to characterise performance - it's been good for developing, but it's not enough for characterising. So, I've taken a step further by rewriting the decoding code to allow tests to be run in batch mode using a folder of 15s wav files. 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 three different configurations of the PyFT8 decoder. The source wav files are copied from https://github.com/kgoba/ft8_lib/tree/master/test/wav/20m_busy, and I've run ft8_lib and PyFT8 for all 38 of them, but only run WSJT-x for 20 so far as it has to be manual cut and paste.

image

It has to be said that adding OSD and bitflipping doesn't produce as significant a difference as I had hoped! So there is certainly scope for further development. I've also seen that despite my efforts to write fast Python, FT8_lib is still considerably faster (and probably faster than WSJT-x). Overall, ignoring WSJT-X, FT8_lib wins in terms of decode numbers, being beaten by PyFT8 on only a few occasions.

Contents

[being written]

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>

About

FT8 Decoding and Encoding in Python with CLI and research code

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages