Add option for folder organisation

Author: G1OJS

README.md

@@ -79,12 +79,13 @@ Note - I keep my all.txt files fairly small by archiving sections into other fil
 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               <- this file is used for the 'single all file' case 
+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                           <- controls the behaviour of the lower SNR plot in the A/B analysis case
+show_best_snrs_only = N           
+use_bandmode_folders = Y
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wsjt_all"
-version = "1.5.0"
+version = "1.6.0"
 license = "MIT"
 license-files = ["LICENSE"]
 

src/wsjt_all/__init__.py

@@ -1,2 +1,2 @@
-from .prog_flow import wsjt_all, wsjt_all_live, wsjt_all_ab, wsjt_all_ab_live
+from .run import wsjt_all, wsjt_all_live, wsjt_all_ab, wsjt_all_ab_live
 

src/wsjt_all/load_sessions.py

@@ -23,6 +23,7 @@ def list_sessions(sessions):
         print(f"{i+1} {get_session_info_string(s)}")
 
 def load_sessions(allfilepath, session_split_guard_secs, skip_all_before = 0):
+    print(f"Reading {allfilepath}")
     decodes =[]
     for line in open(allfilepath):
         if(allstr_to_epoch(line) > skip_all_before):

src/wsjt_all/plotter_dual.py

@@ -83,16 +83,6 @@ def make_chart_dual(plt, fig, axs, decodes_A, decodes_B, session_info, show_best
     fig.suptitle(f"Session: {session_info_string}") 
     plt.tight_layout()
 
-def plot_all_historic_dual(allfilepath_A, allfilepath_B, session_guard_seconds, show_best_snrs_only):
-    sessions_AB, decodes_A, decodes_B = load_overlapping_sessions(allfilepath_A, allfilepath_B, session_guard_seconds)
-    for i, session_info in enumerate(sessions_AB):
-        session_info_string = get_session_info_string(session_info)
-        print(f"Plotting session {i+1} of {len(sessions_AB)}: {session_info_string}")
-        fig, axs = plt.subplots(3,1, figsize=(7, 9), height_ratios = (0.1,1,1))
-        make_chart_dual(plt, fig, axs, decodes_A, decodes_B, session_info, show_best_snrs_only)
-        save_chart(plt, session_info_string+".png")
-        plt.close()
-
 def plot_live_dual(allfilepath_A, allfilepath_B, session_guard_seconds, plot_window_seconds, show_best_snrs_only):
     fig, axs = plt.subplots(3,1, figsize=(7, 9), height_ratios = (0.1,1,1))
     plt.ion()
@@ -111,3 +101,13 @@ def plot_live_dual(allfilepath_A, allfilepath_B, session_guard_seconds, plot_win
             axs[0].cla(), axs[1].cla(), axs[2].cla()
             make_chart_dual(plt, fig, axs, decodes_A, decodes_B, session_info, show_best_snrs_only)
             plt.pause(5)
+
+def plot_all_historic_dual(allfilepath_A, allfilepath_B, subfolder, session_guard_seconds, show_best_snrs_only, use_bandmode_folders):
+    sessions_AB, decodes_A, decodes_B = load_overlapping_sessions(allfilepath_A, allfilepath_B, session_guard_seconds)
+    for i, session_info in enumerate(sessions_AB):
+        session_info_string = get_session_info_string(session_info)
+        print(f"Plotting session {i+1} of {len(sessions_AB)}: {session_info_string}")
+        fig, axs = plt.subplots(3,1, figsize=(7, 9), height_ratios = (0.1,1,1))
+        make_chart_dual(plt, fig, axs, decodes_A, decodes_B, session_info, show_best_snrs_only)
+        save_chart(plt, session_info_string+".png", subfolder, session_info, use_bandmode_folders)
+        plt.close()

src/wsjt_all/plotter_single.py

@@ -47,7 +47,7 @@ def make_chart_single(plt, fig, axs, decodes_A, session_info):
     fig.suptitle(f"Session: {session_info_string}") 
     plt.tight_layout()
 
-def plot_live_single(allfilepath_A, session_guard_seconds, plot_window_seconds, show_best_snrs_only):
+def plot_live_single(allfilepath_A, session_guard_seconds, plot_window_seconds):
     fig, axs = plt.subplots(2,1, figsize=(6, 9), height_ratios = (1,1))
     plt.ion()
     print("Waiting for live session data")
@@ -63,13 +63,13 @@ def plot_live_single(allfilepath_A, session_guard_seconds, plot_window_seconds,
             make_chart_single(plt, fig, axs, decodes_A, session_info)
             plt.pause(5)
 
-def plot_all_historic_single(allfilepath_A, session_guard_seconds):
+def plot_all_historic_single(allfilepath_A, subfolder, session_guard_seconds, use_bandmode_folders):
     decodes_A, sessions_A = load_sessions(allfilepath_A, session_guard_seconds)
     for i, session_info in enumerate(sessions_A):
         if(session_info[1] > session_info[0] and len(sessions_A)>2):
             session_info_string = get_session_info_string(session_info)
             print(f"Plotting session {i+1} of {len(sessions_A)}: {session_info_string}")
             fig, axs = plt.subplots(2,1, figsize=(6, 9), height_ratios = (1,1))
             make_chart_single(plt, fig, axs, decodes_A, session_info)
-            save_chart(plt, session_info_string+"_timeline.png")
+            save_chart(plt, session_info_string+".png", subfolder, session_info, use_bandmode_folders)
             plt.close()

src/wsjt_all/prog_flow.py src/wsjt_all/run.pysrc/wsjt_all/prog_flow.py renamed to src/wsjt_all/run.py

@@ -16,6 +16,7 @@ def check_config():
             txt += "\nsession_guard_seconds = 300"
             txt += "\nlive_plot_window_seconds = 300"
             txt += "\nshow_best_snrs_only = N"
+            txt += "\nuse_bandmode_folders = Y"
             txt += "\n"
             with open("wsjt_all.ini","w") as f:
               f.write(txt)
@@ -30,14 +31,28 @@ def run(option):
         session_guard_seconds = int(config.get("settings","session_guard_seconds"))
         live_plot_window_seconds = int(config.get("settings","live_plot_window_seconds"))
         show_best_snrs_only = (config.get("settings","show_best_snrs_only") == "Y")
+        use_bandmode_folders = (config.get("settings","use_bandmode_folders") == "Y")
+
         if(option=="hist_single"):
-            plot_all_historic_single(allfilepath_A, session_guard_seconds)
+            plot_all_historic_single(allfilepath_A, "A/", session_guard_seconds, use_bandmode_folders)
+            if(allfilepath_A != allfilepath_B):
+                plot_all_historic_single(allfilepath_B, "B/", session_guard_seconds, use_bandmode_folders)
+        if(option=="live_single"):
+            plot_live_single(allfilepath_A,session_guard_seconds, live_plot_window_seconds)
+
         if(option=="hist_ab"):
-            plot_all_historic_dual(allfilepath_A, allfilepath_B, session_guard_seconds, show_best_snrs_only)
+            allfilepath_B = config.get("inputs","allB")    
+            if(allfilepath_A == allfilepath_B):
+                print("AB analysis requires two different all.txt files")
+            else:
+                plot_all_historic_dual(allfilepath_A, allfilepath_B, "AB/", session_guard_seconds, show_best_snrs_only, use_bandmode_folders)
         if(option=="live_ab"):
-            plot_live_dual(allfilepath_A, allfilepath_B, session_guard_seconds, live_plot_window_seconds, show_best_snrs_only)
-        if(option=="live_single"):
-            plot_live_single(allfilepath_A,session_guard_seconds, live_plot_window_seconds,False)
+            allfilepath_B = config.get("inputs","allB")    
+            if(allfilepath_A == allfilepath_B):
+                print("AB analysis requires two different all.txt files")
+            else:
+                plot_live_dual(allfilepath_A, allfilepath_B, session_guard_seconds, live_plot_window_seconds, show_best_snrs_only)
+            
 
 def wsjt_all():
     run("hist_single")

src/wsjt_all/utils.py

@@ -1,17 +1,18 @@
 import hashlib
-global colourseries
 import random
 import os
 
 def hash_color(callsign, cmap):
     h = int(hashlib.sha1(callsign.encode()).hexdigest(), 16)
     return cmap(h % cmap.N)
 
-def save_chart(plt, plotfile):
-    if not os.path.exists("plots"):
-        os.makedirs("plots")
-    print(f"Saving plot plots/{plotfile}")
-    plt.savefig(f"plots/{plotfile}")
+def save_chart(plt, plotfile, subfolder, session_info, use_bandmode_folders):
+    print(use_bandmode_folders)
+    folder = f"plots/{session_info[2].replace('-','/')}/{subfolder}" if(use_bandmode_folders) else "plots"
+    if not os.path.exists(folder):
+        os.makedirs(folder)
+    print(f"Saving {plotfile}")
+    plt.savefig(f"{folder}/{plotfile}")
 
 def dither(vals, amplitude_factor):
     amplitude = amplitude_factor * (max(vals) - min(vals))

tests/wsjt_all.ini

@@ -6,3 +6,4 @@ allB = C:\Users\drala\AppData\Local\WSJT-X - AltAB\all.txt
 session_guard_seconds = 300
 live_plot_window_seconds = 300
 show_best_snrs_only = N
+use_bandmode_folders = Y