chore: cleanup variable names and add docstrings

src/input/input_handling.py

@@ -393,7 +393,7 @@ def add_input_UI_elements() -> None:
     st.session_state.container_metadata_inputs = container_metadata_inputs
 
 
-def dbg_show_observation_hashes():
+def dbg_show_observation_hashes() -> None:
     """
     Displays information about each observation including the hash 
     

src/main.py

@@ -24,7 +24,7 @@ from maps.alps_map import present_alps_map
 from maps.obs_map import present_obs_map
 from utils.st_logs import setup_logging, parse_log_buffer
 from utils.workflow_state import WorkflowFSM, FSM_STATES
-from utils.workflow_ui import refresh_progress, init_workflow_viz
+from utils.workflow_ui import refresh_progress_display, init_workflow_viz
 from hf_push_observations import push_all_observations
 
 from classifier.classifier_image import cetacean_just_classify, cetacean_show_results_and_review, cetacean_show_results
@@ -117,7 +117,7 @@ def main() -> None:
     st.session_state.tab_log = tab_log
 
     # put this early so the progress indicator is at the top (also refreshed at end)
-    refresh_progress()    
+    refresh_progress_display()    
 
     # create a sidebar, and parse all the input (returned as `observations` object)
     with st.sidebar:
@@ -265,7 +265,7 @@ def main() -> None:
                 # trigger a refresh too (refreshhing the prog indicator means the script reruns and 
                 # we can enter the next state - visualising the results / review)
                 # ok it doesn't if done programmatically. maybe interacting with teh button? check docs.
-                refresh_progress()
+                refresh_progress_display()
                 #TODO: validate this doesn't harm performance adversely.
                 st.rerun()
         
@@ -373,7 +373,7 @@ def main() -> None:
             
             
     # after all other processing, we can show the stage/state
-    refresh_progress()
+    refresh_progress_display()
 
 
 if __name__ == "__main__":

src/utils/workflow_ui.py

@@ -1,18 +1,41 @@
 import streamlit as st
 
-def refresh_progress():
+def refresh_progress_display() -> None:
+    """
+    Updates the workflow progress display in the Streamlit sidebar.
+    """
     with st.sidebar:
-        tot = st.session_state.workflow_fsm.num_states - 1
-        cur_i = st.session_state.workflow_fsm.current_state_index
-        cur_t = st.session_state.workflow_fsm.current_state
-        st.session_state.disp_progress[0].markdown(f"*Progress: {cur_i}/{tot}. Current: {cur_t}.*")
-        st.session_state.disp_progress[1].progress(cur_i/tot)
+        num_states = st.session_state.workflow_fsm.num_states - 1
+        current_state_index = st.session_state.workflow_fsm.current_state_index
+        current_state_name = st.session_state.workflow_fsm.current_state
+        colour = 'primary' 
+        if current_state_index == num_states: # highlight that we finished
+            colour = 'green'
+        status = f":{colour}[*Progress: {current_state_index}/{num_states}. Current: {current_state_name}.*]"
+        
+        st.session_state.disp_progress[0].markdown(status)
+        st.session_state.disp_progress[1].progress(current_state_index/num_states)
+
+    
+def init_workflow_viz(debug:bool=True) -> None:
+    """
+    Set up the streamlit elements for visualising the workflow progress.
+
+    Adds placeholders for progress indicators, and adds a button to manually refresh
+    the displayed progress. Note: The button is mainly a development aid.
+
+    Args:
+        debug (bool): If True, include the manual refresh button. Default is True.
+        
+    """
+
     
-def init_workflow_viz():
+    #Initialise the layout containers used in the input handling
     # add progress indicator to session_state
     if "progress" not in st.session_state:
         with st.sidebar:
             st.session_state.disp_progress = [st.empty(), st.empty()]
-            # add button to sidebar, with the callback to refesh_progress
-            st.sidebar.button("Refresh Progress", on_click=refresh_progress)
+            if debug:
+                # add button to sidebar, with the callback to refesh_progress
+                st.sidebar.button("Refresh Progress", on_click=refresh_progress_display)