release v-0.1.0

.gitattributes

@@ -0,0 +1 @@
+RCG.exe filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -127,3 +127,13 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.idea/dbnavigator.xml
+.gitignore
+.gitignore
+.gitignore
+.idea/inspectionProfiles/Project_Default.xml
+.idea/inspectionProfiles/profiles_settings.xml
+.idea/rapid-catchment-generator.iml
+.idea/modules.xml
+.idea/misc.xml
+.idea/vcs.xml

gui/app.py

@@ -1,120 +1,150 @@
 import os
 import sys
 import tkinter as tk
-from tkinter import ttk
-from tkinter import messagebox
-from tkinter import filedialog
+from tkinter import filedialog, messagebox, ttk
 
 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 from rcg.runner import generate_subcatchment
 
 
+def get_help_file_path():
+    if getattr(sys, "frozen", False):
+        base_path = sys._MEIPASS
+    else:
+        base_path = os.path.abspath(".")
+    return os.path.join(base_path, "gui", "help_content.txt")
+
+
 class RcgApp:
     def __init__(self, root):
         self.root = root
         self.file_path = None
         self.root.title("Rapid Catchment Generator")
-        self.set_window_size(width=340, height=270)
+        self.set_window_size(width=340, height=300)
         self.create_widgets()
 
     def set_window_size(self, width, height):
         self.root.geometry(f"{width}x{height}")
 
     def create_widgets(self):
-        # Tworzenie rozwijanej listy LandCover
         land_cover_label = tk.Label(self.root, text="Select land cover type:")
         land_cover_label.grid(row=0, column=0, padx=10, pady=10, sticky="w")
 
         self.land_cover_var = tk.StringVar()
         land_cover_combobox = ttk.Combobox(
             self.root,
-            textvariable=self.land_cover_var, 
+            textvariable=self.land_cover_var,
             values=[
-                "medium conditions",
-                "permeable areas",
-                "permeable terrain on plains",
-                "hilly",
-                "mountains",
-                "bare rocky slopes",
-                "urban",
-                "suburban",
+                "permeable_areas",
+                "permeable_terrain_on_plains",
+                "mountains_vegetated",
+                "mountains_rocky",
+                "urban_weakly_impervious",
+                "urban_moderately_impervious",
+                "urban_highly_impervious",
+                "suburban_weakly_impervious",
+                "suburban_highly_impervious",
                 "rural",
                 "forests",
                 "meadows",
                 "arable",
                 "marshes",
             ],
-            width=25
-            )
+            width=25,
+        )
         land_cover_combobox.grid(row=0, column=1, padx=10, pady=10)
 
-        # Tworzenie rozwijanej listy LandType
         land_form_label = tk.Label(self.root, text="Select land form type:")
         land_form_label.grid(row=1, column=0, padx=10, pady=10, sticky="w")
 
         self.land_form_var = tk.StringVar()
         land_form_combobox = ttk.Combobox(
-            self.root, 
-            textvariable=self.land_form_var, 
+            self.root,
+            textvariable=self.land_form_var,
             values=[
-                "marshes and lowlands",
-                "flats and plateaus",
-                "flats and plateaus in combination with hills",
-                "hills with gentle slopes",
-                "steeper hills and foothills",
-                "hills and outcrops of mountain ranges",
-                "higher hills",
+                "marshes_and_lowlands",
+                "flats_and_plateaus",
+                "flats_and_plateaus_in_combination_with_hills",
+                "hills_with_gentle_slopes",
+                "steeper_hills_and_foothills",
+                "hills_and_outcrops_of_mountain_ranges",
+                "higher_hills",
                 "mountains",
-                "highest mountains",
-            ], 
-            width=25
-            )
+                "highest_mountains",
+            ],
+            width=25,
+        )
         land_form_combobox.grid(row=1, column=1, padx=10, pady=10)
 
-        # Tworzenie pola do wprowadzenia parametru Area
         area_label = tk.Label(self.root, text="Area [ha]:")
         area_label.grid(row=2, column=0, padx=10, pady=10, sticky="w")
 
         self.area_var = tk.StringVar()
         area_entry = tk.Entry(self.root, textvariable=self.area_var, width=28)
         area_entry.grid(row=2, column=1, padx=10, pady=10)
 
-        # Selecting file
         file_label = tk.Label(self.root, text="Select file:")
         file_label.grid(row=3, column=0, padx=10, pady=10, sticky="w")
 
-        choose_file_button = tk.Button(self.root, text="Select file", command=self.choose_file, width=23)
+        choose_file_button = tk.Button(
+            self.root, text="Select file", command=self.choose_file, width=23
+        )
         choose_file_button.grid(row=3, column=1, padx=10, pady=10)
 
-        # Selected file
         selected_label = tk.Label(self.root, text="Selected file:")
         selected_label.grid(row=4, column=0, padx=10, pady=10, sticky="w")
 
-        self.selected_file_label = tk.Entry(self.root, width=28, state='readonly')
+        self.selected_file_label = tk.Entry(self.root, width=28, state="readonly")
         self.selected_file_label.grid(row=4, column=1, padx=10, pady=10, sticky="w")
 
-        # Tworzenie przycisku Run
         run_label = tk.Label(self.root, text="Run simulation:")
         run_label.grid(row=5, column=0, padx=10, pady=10, sticky="w")
 
-        run_button = tk.Button(self.root, text="Run", command=self.run_simulation, width=23, bg="#36D7B7")
+        run_button = tk.Button(
+            self.root, text="Run", command=self.run_simulation, width=23, bg="#36D7B7"
+        )
         run_button.grid(row=5, column=1, padx=10, pady=10, sticky="w")
 
+        help_button = tk.Button(
+            self.root, text="Help", command=self.show_help, width=23, bg="#a5d8ff"
+        )
+        help_button.grid(row=6, column=1, padx=10, pady=10, sticky="w")
+
+    def show_help(self):
+        help_window = tk.Toplevel(self.root)
+        help_window.title("Help - Categories and Instructions")
+        help_window.geometry("400x400")
+
+        try:
+            with open(get_help_file_path(), "r") as file:
+                text = file.read()
+        except FileNotFoundError:
+            messagebox.showerror("Error", "Help file not found.")
+            return
+
+        help_text = tk.Text(help_window, wrap="word", width=50, height=20)
+        help_text.insert(tk.END, text)
+        help_text.config(state="disabled")
+        help_text.pack(padx=10, pady=10, expand=True, fill=tk.BOTH)
+
     def choose_file(self):
-        file_path = filedialog.askopenfilename(title="Wybierz plik", filetypes=(("Pliki tekstowe", "*.txt"), ("Wszystkie pliki", "*.*")))
+        file_path = filedialog.askopenfilename(
+            title="Select file",
+            filetypes=(("Text files", "*.txt"), ("All files", "*.*")),
+        )
         if file_path:
-            # Sprawdź, czy plik ma rozszerzenie ".inp"
             file_extension = os.path.splitext(file_path)[1]
             if file_extension.lower() != ".inp":
-                messagebox.showerror("Error", "Please select a file with the '.inp' extension.")
+                messagebox.showerror(
+                    "Error", "Please select a file with the '.inp' extension."
+                )
                 return
 
-            # Aktualizowanie pola tekstowego z nazwą pliku
-            self.selected_file_label.config(state='normal')
+            self.selected_file_label.config(state="normal")
             self.selected_file_label.delete(0, tk.END)
             self.selected_file_label.insert(0, file_path)
-            self.selected_file_label.config(state='readonly')
+            self.selected_file_label.config(state="readonly")
 
             self.file_path = file_path
 
@@ -128,30 +158,39 @@ def run_simulation(self):
             return
 
         if not land_cover:
-            messagebox.showerror("Error", "Please select a value for 'Land cover type'.")
+            messagebox.showerror(
+                "Error", "Please select a value for 'Land cover type'."
+            )
             return
 
         if not land_form:
             messagebox.showerror("Error", "Please select a value for 'Land form type'.")
             return
 
         if not area:
-            messagebox.showerror("Error", "Please enter a value for the 'Area' parameter.")
+            messagebox.showerror(
+                "Error", "Please enter a value for the 'Area' parameter."
+            )
             return
 
         try:
             area = area.replace(",", ".")
             area = float(area)
         except ValueError:
-            messagebox.showerror("Error", "Please enter a valid value for the 'Area' parameter.")
+            messagebox.showerror(
+                "Error", "Please enter a valid value for the 'Area' parameter."
+            )
             return
 
         generate_subcatchment(self.file_path, area, land_form, land_cover)
 
-        messagebox.showinfo("Information", f"Simulation has been executed successfully for values: \n\nArea: {area}\nLand cover type: {land_cover}\nLand form type: {land_form}\nFile: {self.file_path}")
+        messagebox.showinfo(
+            "Information",
+            f"Simulation has been executed successfully for values: \n\nArea: {area}\nLand cover type: {land_cover}\nLand form type: {land_form}\nFile: {self.file_path}",
+        )
+
 
 if __name__ == "__main__":
     root = tk.Tk()
-    root.iconbitmap("gui\icon.png")
     app = RcgApp(root)
     root.mainloop()