Skip to content

Fix GUI crash when canceling file selection on startup #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sierd merged 4 commits into from
Nov 4, 2025
Merged

Fix GUI crash when canceling file selection on startup #256

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06b29d0
Initial plan
Copilot Nov 4, 2025
5eb7484
Fix GUI to handle cancel on startup gracefully
Copilot Nov 4, 2025
459370a
Address code review feedback: move import to top and remove hardcoded…
Copilot Nov 4, 2025
68c62bb
Remove placeholder path, set configfile to 'No file selected' when ca…
Copilot Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 45 additions & 24 deletions aeolis/gui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,36 @@
import matplotlib.pyplot as plt
from matplotlib.backends.backend_tkagg import FigureCanvasTkAgg
from matplotlib.figure import Figure
from aeolis.constants import DEFAULT_CONFIG

try:
import netCDF4
HAVE_NETCDF = True
except ImportError:
HAVE_NETCDF = False

# Default configuration file path
configfile = r'C:\Users\svries\Documents\GitHub\OE_aeolis-python\aeolis\examples\2D\Barchan_dune\aeolis.txt'

# Function to prompt the user to select a configuration file
def prompt_file():
file_path = filedialog.askopenfilename(
initialdir=os.path.dirname(configfile),
initialdir=os.getcwd(),
title="Select config file",
filetypes=(("Text files", "*.txt"), ("All files", "*.*"))
)
return file_path if file_path else configfile
return file_path

# Prompt the user to select a configuration file or use the default
configfile = prompt_file()
selected_file = prompt_file()

# Read the configuration file into a dictionary
dic = aeolis.inout.read_configfile(configfile)
if selected_file:
# User selected a file
configfile = selected_file
dic = aeolis.inout.read_configfile(configfile)
else:
# User canceled - load empty fields with defaults
configfile = "No file selected"
# Use the default configuration from constants
dic = DEFAULT_CONFIG.copy()

class AeolisGUI:
def __init__(self, root, dic):
Expand All @@ -42,6 +49,17 @@ def __init__(self, root, dic):

self.create_widgets()

def get_config_dir(self):
"""Get the directory of the config file, or current directory if no file selected"""
global configfile
if configfile and configfile != "No file selected" and os.path.exists(configfile):
return os.path.dirname(configfile)
elif configfile and configfile != "No file selected" and os.path.dirname(configfile):
# configfile might be a path even if file doesn't exist yet
return os.path.dirname(configfile)
else:
return os.getcwd()

def create_widgets(self):
# Create a tab control widget
tab_control = ttk.Notebook(self.root)
Expand All @@ -60,7 +78,8 @@ def create_label_entry(self, tab, text, value, row):
label = ttk.Label(tab, text=text)
label.grid(row=row, column=0, sticky=W)
entry = ttk.Entry(tab)
entry.insert(0, str(value))
# Convert None to empty string for cleaner display
entry.insert(0, '' if value is None else str(value))
entry.grid(row=row, column=1, sticky=W)
return entry

Expand Down Expand Up @@ -126,7 +145,9 @@ def create_domain_tab(self, tab_control):
label = ttk.Label(params_frame, text=f"{field}:")
label.grid(row=i, column=0, sticky=W, pady=2)
entry = ttk.Entry(params_frame, width=35)
entry.insert(0, str(self.dic.get(field, '')))
value = self.dic.get(field, '')
# Convert None to empty string for cleaner display
entry.insert(0, '' if value is None else str(value))
entry.grid(row=i, column=1, sticky=W, pady=2, padx=(0, 5))
self.entries[field] = entry

Expand Down Expand Up @@ -174,7 +195,7 @@ def create_domain_tab(self, tab_control):
def browse_file(self, entry_widget):
"""Open file dialog to select a file and update the entry widget"""
# Get initial directory from config file location
initial_dir = os.path.dirname(configfile)
initial_dir = self.get_config_dir()

# Get current value to determine initial directory
current_value = entry_widget.get()
Expand All @@ -197,14 +218,14 @@ def browse_file(self, entry_widget):
# Update entry if a file was selected
if file_path:
# Try to make path relative to config file directory for portability
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()
try:
rel_path = os.path.relpath(file_path, config_dir)
# Use relative path if it doesn't go up too many levels
if not rel_path.startswith('..\\..\\'):
file_path = rel_path
except ValueError:
# Different drives on Windows, keep absolute path
except (ValueError, TypeError):
# Different drives on Windows or invalid path, keep absolute path
pass

entry_widget.delete(0, END)
Expand All @@ -213,7 +234,7 @@ def browse_file(self, entry_widget):
def browse_nc_file(self):
"""Open file dialog to select a NetCDF file"""
# Get initial directory from config file location
initial_dir = os.path.dirname(configfile)
initial_dir = self.get_config_dir()

# Get current value to determine initial directory
current_value = self.nc_file_entry.get()
Expand All @@ -236,14 +257,14 @@ def browse_nc_file(self):
# Update entry if a file was selected
if file_path:
# Try to make path relative to config file directory for portability
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()
try:
rel_path = os.path.relpath(file_path, config_dir)
# Use relative path if it doesn't go up too many levels
if not rel_path.startswith('..\\..\\'):
file_path = rel_path
except ValueError:
# Different drives on Windows, keep absolute path
except (ValueError, TypeError):
# Different drives on Windows or invalid path, keep absolute path
pass

self.nc_file_entry.delete(0, END)
Expand All @@ -255,7 +276,7 @@ def load_new_config(self):

# Open file dialog
file_path = filedialog.askopenfilename(
initialdir=os.path.dirname(configfile),
initialdir=self.get_config_dir(),
title="Select config file",
filetypes=(("Text files", "*.txt"), ("All files", "*.*"))
)
Expand Down Expand Up @@ -290,7 +311,7 @@ def browse_save_location(self):
"""Browse for save location for config file"""
# Open file dialog for saving
file_path = filedialog.asksaveasfilename(
initialdir=os.path.dirname(configfile),
initialdir=self.get_config_dir(),
title="Save config file as",
defaultextension=".txt",
filetypes=(("Text files", "*.txt"), ("All files", "*.*"))
Expand Down Expand Up @@ -507,7 +528,7 @@ def plot_data(self, file_key, title):
return

# Get the directory of the config file to resolve relative paths
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()

# Load the data file
if not os.path.isabs(data_file):
Expand Down Expand Up @@ -606,7 +627,7 @@ def plot_combined(self):
return

# Get the directory of the config file to resolve relative paths
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()

# Load the bed file
if not os.path.isabs(bed_file):
Expand Down Expand Up @@ -716,7 +737,7 @@ def plot_nc_bed_level(self):
return

# Get the directory of the config file to resolve relative paths
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()

# Load the NC file
if not os.path.isabs(nc_file):
Expand Down Expand Up @@ -954,7 +975,7 @@ def plot_nc_wind(self):
if not nc_file:
messagebox.showwarning("Warning", "No NetCDF file specified!")
return
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()
nc_file_path = os.path.join(config_dir, nc_file) if not os.path.isabs(nc_file) else nc_file
if not os.path.exists(nc_file_path):
messagebox.showerror("Error", f"NetCDF file not found: {nc_file_path}")
Expand Down Expand Up @@ -1082,7 +1103,7 @@ def enable_overlay_vegetation(self):
if not nc_file:
messagebox.showwarning("Warning", "No NetCDF file specified!")
return
config_dir = os.path.dirname(configfile)
config_dir = self.get_config_dir()
nc_file_path = os.path.join(config_dir, nc_file) if not os.path.isabs(nc_file) else nc_file
if not os.path.exists(nc_file_path):
messagebox.showerror("Error", f"NetCDF file not found: {nc_file_path}")
Expand Down