Name | wsjt-all JSON |
Version |
1.7.2
JSON |
| download |
home_page | None |
Summary | Automated plots and analysis from the WSJT-X ALL.txt file |
upload_time | 2025-09-07 20:23:38 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | None |
keywords |
hamradio
wsjt
wsjt-x
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
<img align="right" height="350" src="https://github.com/user-attachments/assets/656d2b19-4ef9-41f8-9490-98db032a40c4"/>
# wsjt_all [](https://pepy.tech/projects/wsjt-all)
**A Python command-line tool to analyse WSJT-X 'all.txt' files**
## Purpose
The point of this tool is to make analysing the WSJT-X 'all.txt' files easier, avoiding having to open them with text editors, and providing various plots and statistical summaries. The 'all.txt' file produced by WSJT-X contains a wealth of information about your station's receive performance that is mostly untapped.
The software works with pairs of all.txt files (to compare overlapping sessions) as well as individual ones.
**Example use cases** include:
- Benchmarking your receive capability against a Web SDR
- Doing local A/B testing with two configurations, using a Web SDR as a stable reference (compare A vs Web SDR with B vs Web SDR at two different times, when you can't do A and B simultaneously)
- Look for patterns in decode rate over time
- Check if patterns apply to all decodes or just groups
- Make a change where you have to leave your screen, come back and see what happened to the decode rate (good for QRM hunting / elimination!)
- Just get a quick visual look at what's in your all.txt file!
## More detail ...
For more detail on the motivation behind this project which *started* with A/B testing with a pair of all.txt files, have a look at this page:
[AB Testing with FT8](https://g1ojs.github.io/wsjt_all/docs/AB-testing-FT8.html).
## Features
**1) For a single 'all.txt' file:**
* Automatically parse an ALL.txt file and detect sessions of activity
* Automatically produce the following plots for each session
* decode rate (decodes / minute) across the session
* SNR for each report for each callsign across the session
**2) For a pair of 'all.txt' files:**
* Automatically parse a pair (A,B) of ALL.txt files and detect sessions of activity that are common to both files
* Automatically produce the following plots for each session
* number of callsigns decoded in A and B
* number of decodes at A and B for each callsign
* SNRs in A and B for simultaneous decodes
**For both use cases:**
* Run as a batch process to process all historic sessions
* Run 'live' to monitor a current & ongoing test
* (Limited) plotting options
## Motivation
My own pesonal motivation here is to compare my reception performance, in a fairly dense urban/sub-urban location, with reception at a remote site (web SDR). To do this, I run two separate instances of WSJT-X, with one connected to the transceiver as normal, and the other receiving audio via a virtual cable from a web SDR running in a browser window. This results in a second ALL.txt file with a few sessions that overlap the sessions in the large 'main' all.txt file. Browsing these files to compare reception is not trivial, and getting a good overview of the differences is difficult - hence, this software.
I will probably develop this next to produce plots from *single* ALL.txt files, and produce more / different plots etc.
The questions I had in my mind, that I wrote this to try to answer, include:
- At the basic level, how does my receive performance (All file A) compare to that of a 'good reference' (All file B): number of callsigns collected at each, comparison of SNR when both A and B receive the same callsign either simultaneously or within a specified time window.
- How does that comparison change over time? Are signals fading in at A and out at B & vice versa? Is this true only for some callsigns and are the rest static or going the other way?
- How variable is SNR at A, and at B?
- What does SNR correlate with at A and B, if anything? (e.g. distance, bearing)
- What's more meaningful, SNR or number of times a callsign is received over a time window?
## Outputs
[**Note**: *I have just uploaded V1.4 with the addition of single all.txt file processing, and need to update the section below a little*]
After you run the program, you will find a 'plots' folder in which you will find plots like this:
<img width="700" height="900" alt="3 573MHz-FT8 2025-08-09 2233 for 29 75 mins" src="https://github.com/user-attachments/assets/656d2b19-4ef9-41f8-9490-98db032a40c4" />
The very top of the figure shows the session information (this example was 80m late on a summer evening) with a Venn diagram-style ribbon showing the number of callsigns in each 'all.txt' file. In my case when producing this example, all.txt file A was generated by my usual station setup, and all.txt file B was generated by a second instance of WSJT-X connected to the audio from the Hack Green WebSDR.
In the upper plot, the markers represent each callsign detected in the session, and the marker position shows the number of times each callsign was seen within the session time window in each all.txt file. To allow visibility of markers that lie on top of each other, some random position errors are deliberately added. Markers lying on the X axis or Y axis were seen in only one of the all files.
In the lower plot, the markers represent each signal report (SNR in dB) found, plotting one 'all.txt' file against the other. Reports falling on the dashed black line are equal in SNR between the two files / reception configurations. Reports from a given remote callsign are shown as a collection by coloring them a specific (but random) colour per callsign, and by joining the markers with lines. Of course, there are typically far more callsigns than colours available, so colours are re-used across different callsigns.
## Installation
Install with pip:
```
pip install wsjt_all
```
## Usage
There are currently four simple command line commands to use:
**wsjt_all** parses a single all file, automatically finding 'sessions' (defined time ranges covering reception of a single mode on a single band) and producing a timeline plot of decode rate and SNR.
**wsjt_all_live** analyses the very last session in the all files, and plots a live-updating plot covering the current time to 5 minutes ago. It will be blank if you are not currently running WSJT-X.
**wsjt_all_ab** runs the A/B comparison described above, automatically finding 'sessions' (defined time ranges covering reception of a single mode on a single band) and then automatically finding sessions that are common to both all files. A plot is produced and saved in the 'plots' folder for every common session.
**wsjt_all_ab_live** analyses the very last session in the all files, and plots a live-updating plot covering the current time to 5 minutes ago. It will be blank if you are not currently running two instances of WSJT-X as described above.
Note - I keep my all.txt files fairly small by archiving sections into other files, so if you have a single all file covering years of operation, you may have to edit it or wait quite a while for the plots!
## Configuration
The software uses a simple wsjt_all.ini file to locate the all.txt files and set a couple of options. If none exists, the software can create a template for you but you still need to edit it to specify the paths to the all files. The wsjt_all.ini file looks like this:
```
[inputs]
allA = C:\Users\drala\AppData\Local\WSJT-X\all.txt
allB = C:\Users\drala\AppData\Local\WSJT-X - AltAB\all.txt
[settings]
session_guard_seconds = 300
live_plot_window_seconds = 300
show_best_snrs_only = N
use_bandmode_folders = Y
```
Raw data
{
"_id": null,
"home_page": null,
"name": "wsjt-all",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "hamradio, WSJT, WSJT-X",
"author": null,
"author_email": "G1OJS <g1ojs@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/25/07/798355073eb177eacf05f1e582ee05b37dd7f4d104cdc9d0d4b9f287d007/wsjt_all-1.7.2.tar.gz",
"platform": null,
"description": "<img align=\"right\" height=\"350\" src=\"https://github.com/user-attachments/assets/656d2b19-4ef9-41f8-9490-98db032a40c4\"/> \r\n\r\n# wsjt_all [](https://pepy.tech/projects/wsjt-all)\r\n**A Python command-line tool to analyse WSJT-X 'all.txt' files**\r\n## Purpose\r\nThe point of this tool is to make analysing the WSJT-X 'all.txt' files easier, avoiding having to open them with text editors, and providing various plots and statistical summaries. The 'all.txt' file produced by WSJT-X contains a wealth of information about your station's receive performance that is mostly untapped.\r\n\r\nThe software works with pairs of all.txt files (to compare overlapping sessions) as well as individual ones.\r\n\r\n**Example use cases** include:\r\n- Benchmarking your receive capability against a Web SDR\r\n- Doing local A/B testing with two configurations, using a Web SDR as a stable reference (compare A vs Web SDR with B vs Web SDR at two different times, when you can't do A and B simultaneously)\r\n- Look for patterns in decode rate over time\r\n- Check if patterns apply to all decodes or just groups\r\n- Make a change where you have to leave your screen, come back and see what happened to the decode rate (good for QRM hunting / elimination!)\r\n- Just get a quick visual look at what's in your all.txt file! \r\n\r\n## More detail ...\r\nFor more detail on the motivation behind this project which *started* with A/B testing with a pair of all.txt files, have a look at this page:\r\n\r\n[AB Testing with FT8](https://g1ojs.github.io/wsjt_all/docs/AB-testing-FT8.html).\r\n\r\n## Features\r\n**1) For a single 'all.txt' file:**\r\n* Automatically parse an ALL.txt file and detect sessions of activity \r\n* Automatically produce the following plots for each session\r\n * decode rate (decodes / minute) across the session\r\n * SNR for each report for each callsign across the session\r\n \r\n**2) For a pair of 'all.txt' files:**\r\n* Automatically parse a pair (A,B) of ALL.txt files and detect sessions of activity that are common to both files\r\n* Automatically produce the following plots for each session\r\n * number of callsigns decoded in A and B\r\n * number of decodes at A and B for each callsign\r\n * SNRs in A and B for simultaneous decodes\r\n \r\n**For both use cases:**\r\n * Run as a batch process to process all historic sessions\r\n * Run 'live' to monitor a current & ongoing test\r\n * (Limited) plotting options\r\n\r\n## Motivation\r\nMy own pesonal motivation here is to compare my reception performance, in a fairly dense urban/sub-urban location, with reception at a remote site (web SDR). To do this, I run two separate instances of WSJT-X, with one connected to the transceiver as normal, and the other receiving audio via a virtual cable from a web SDR running in a browser window. This results in a second ALL.txt file with a few sessions that overlap the sessions in the large 'main' all.txt file. Browsing these files to compare reception is not trivial, and getting a good overview of the differences is difficult - hence, this software.\r\n\r\nI will probably develop this next to produce plots from *single* ALL.txt files, and produce more / different plots etc.\r\n\r\nThe questions I had in my mind, that I wrote this to try to answer, include:\r\n - At the basic level, how does my receive performance (All file A) compare to that of a 'good reference' (All file B): number of callsigns collected at each, comparison of SNR when both A and B receive the same callsign either simultaneously or within a specified time window.\r\n - How does that comparison change over time? Are signals fading in at A and out at B & vice versa? Is this true only for some callsigns and are the rest static or going the other way?\r\n - How variable is SNR at A, and at B?\r\n - What does SNR correlate with at A and B, if anything? (e.g. distance, bearing)\r\n - What's more meaningful, SNR or number of times a callsign is received over a time window?\r\n\r\n## Outputs\r\n[**Note**: *I have just uploaded V1.4 with the addition of single all.txt file processing, and need to update the section below a little*]\r\n\r\nAfter you run the program, you will find a 'plots' folder in which you will find plots like this:\r\n\r\n<img width=\"700\" height=\"900\" alt=\"3 573MHz-FT8 2025-08-09 2233 for 29 75 mins\" src=\"https://github.com/user-attachments/assets/656d2b19-4ef9-41f8-9490-98db032a40c4\" />\r\n\r\nThe very top of the figure shows the session information (this example was 80m late on a summer evening) with a Venn diagram-style ribbon showing the number of callsigns in each 'all.txt' file. In my case when producing this example, all.txt file A was generated by my usual station setup, and all.txt file B was generated by a second instance of WSJT-X connected to the audio from the Hack Green WebSDR.\r\n\r\nIn the upper plot, the markers represent each callsign detected in the session, and the marker position shows the number of times each callsign was seen within the session time window in each all.txt file. To allow visibility of markers that lie on top of each other, some random position errors are deliberately added. Markers lying on the X axis or Y axis were seen in only one of the all files.\r\n\r\nIn the lower plot, the markers represent each signal report (SNR in dB) found, plotting one 'all.txt' file against the other. Reports falling on the dashed black line are equal in SNR between the two files / reception configurations. Reports from a given remote callsign are shown as a collection by coloring them a specific (but random) colour per callsign, and by joining the markers with lines. Of course, there are typically far more callsigns than colours available, so colours are re-used across different callsigns. \r\n\r\n## Installation\r\nInstall with pip:\r\n```\r\npip install wsjt_all\r\n```\r\n\r\n## Usage\r\nThere are currently four simple command line commands to use:\r\n\r\n**wsjt_all** parses a single all file, automatically finding 'sessions' (defined time ranges covering reception of a single mode on a single band) and producing a timeline plot of decode rate and SNR.\r\n\r\n**wsjt_all_live** analyses the very last session in the all files, and plots a live-updating plot covering the current time to 5 minutes ago. It will be blank if you are not currently running WSJT-X.\r\n\r\n**wsjt_all_ab** runs the A/B comparison described above, automatically finding 'sessions' (defined time ranges covering reception of a single mode on a single band) and then automatically finding sessions that are common to both all files. A plot is produced and saved in the 'plots' folder for every common session.\r\n\r\n**wsjt_all_ab_live** analyses the very last session in the all files, and plots a live-updating plot covering the current time to 5 minutes ago. It will be blank if you are not currently running two instances of WSJT-X as described above.\r\n\r\nNote - I keep my all.txt files fairly small by archiving sections into other files, so if you have a single all file covering years of operation, you may have to edit it or wait quite a while for the plots!\r\n\r\n## Configuration\r\nThe software uses a simple wsjt_all.ini file to locate the all.txt files and set a couple of options. If none exists, the software can create a template for you but you still need to edit it to specify the paths to the all files. The wsjt_all.ini file looks like this:\r\n```\r\n[inputs]\r\nallA = C:\\Users\\drala\\AppData\\Local\\WSJT-X\\all.txt \r\nallB = C:\\Users\\drala\\AppData\\Local\\WSJT-X - AltAB\\all.txt\r\n\r\n[settings]\r\nsession_guard_seconds = 300\r\nlive_plot_window_seconds = 300\r\nshow_best_snrs_only = N \r\nuse_bandmode_folders = Y\r\n```\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Automated plots and analysis from the WSJT-X ALL.txt file",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://github.com/G1OJS/wsjt_all",
"Issues": "https://github.com/G1OJS/wsjt_all/issues"
},
"split_keywords": [
"hamradio",
" wsjt",
" wsjt-x"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9284182e503cd9208f1ea005681c72bb1a4a4ac2545b48e5cbb77ac6ee309cb5",
"md5": "f1ef29e38d140c6fe48218c536fdbed5",
"sha256": "c4fe2d97c8133a94dd8c14c5373095a1bbd53544223ca2b3bf43d2f55eccd3d1"
},
"downloads": -1,
"filename": "wsjt_all-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1ef29e38d140c6fe48218c536fdbed5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11723,
"upload_time": "2025-09-07T20:23:37",
"upload_time_iso_8601": "2025-09-07T20:23:37.493047Z",
"url": "https://files.pythonhosted.org/packages/92/84/182e503cd9208f1ea005681c72bb1a4a4ac2545b48e5cbb77ac6ee309cb5/wsjt_all-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2507798355073eb177eacf05f1e582ee05b37dd7f4d104cdc9d0d4b9f287d007",
"md5": "79bbd906929d7025840816e72b2f2358",
"sha256": "b7ef18b80f169c7262df52166a6a7d1d5557209bd4d9f17345403e4969184392"
},
"downloads": -1,
"filename": "wsjt_all-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "79bbd906929d7025840816e72b2f2358",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13260,
"upload_time": "2025-09-07T20:23:38",
"upload_time_iso_8601": "2025-09-07T20:23:38.380974Z",
"url": "https://files.pythonhosted.org/packages/25/07/798355073eb177eacf05f1e582ee05b37dd7f4d104cdc9d0d4b9f287d007/wsjt_all-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-07 20:23:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "G1OJS",
"github_project": "wsjt_all",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wsjt-all"
}