├── GPSnauticalSpeed_rev003_006.png ├── LICENSE ├── GPSnauticalSpeed_rev004.py └── README.md /GPSnauticalSpeed_rev003_006.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabiomatricardi/GPSmarineCalculator/main/GPSnauticalSpeed_rev003_006.png -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /GPSnauticalSpeed_rev004.py: -------------------------------------------------------------------------------- 1 | import tkinter as tk 2 | from tkinter import simpledialog, messagebox, ttk, filedialog 3 | import geopy.distance 4 | import folium 5 | import webbrowser 6 | import os 7 | import threading 8 | from datetime import datetime 9 | import tempfile 10 | 11 | 12 | # --- Safe function to create and open map in browser --- 13 | def open_map_in_browser(m): 14 | temp_dir = tempfile.gettempdir() 15 | html_filename = os.path.join(temp_dir, "gps_distance_map.html") 16 | 17 | try: 18 | m.save(html_filename) 19 | webbrowser.open(f"file://{html_filename}") 20 | print(f"Map saved to {html_filename} and opened in browser.") 21 | except Exception as e: 22 | messagebox.showerror("Error", f"Failed to save or open map: {str(e)}") 23 | 24 | 25 | # --- Save results to file in current directory --- 26 | def save_results_to_file(points, travel_hours, total_distance, avg_speed, start_time, end_time): 27 | current_dir = os.getcwd() 28 | timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S") 29 | filename = f"gps_results_{timestamp}.txt" 30 | 31 | file_path = os.path.join(current_dir, filename) 32 | 33 | try: 34 | with open(file_path, 'w', encoding='utf-8') as f: 35 | f.write("=== GPS Distance Calculation Results ===\n\n") 36 | f.write(f"Generated on: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n\n") 37 | f.write(f"Start Time: {start_time.strftime('%Y-%m-%d %H:%M') if start_time else 'N/A'}\n") 38 | f.write(f"End Time: {end_time.strftime('%Y-%m-%d %H:%M') if end_time else 'N/A'}\n") 39 | f.write(f"Travel Time: {travel_hours:.1f} hours\n") 40 | f.write(f"Total Distance: {total_distance:.2f} nautical miles\n") 41 | f.write(f"Average Speed: {avg_speed:.2f} knots\n\n") 42 | f.write("List of Points (Latitude, Longitude):\n") 43 | for i, (lat, lon) in enumerate(points): 44 | f.write(f" Point {i+1}: {lat:.6f}, {lon:.6f}\n") 45 | messagebox.showinfo("Save Success", f"Results saved to:\n{file_path}") 46 | except Exception as e: 47 | messagebox.showerror("Save Error", f"Failed to save file: {str(e)}") 48 | 49 | 50 | # --- Load GPS points from a CSV/TXT file --- 51 | def load_points_from_file(): 52 | file_path = filedialog.askopenfilename( 53 | title="Select GPS Points File", 54 | filetypes=[("Text/CSV Files", "*.txt *.csv"), ("All Files", "*.*")] 55 | ) 56 | if not file_path: 57 | return [] 58 | 59 | points = [] 60 | try: 61 | with open(file_path, 'r', encoding='utf-8') as f: 62 | lines = f.readlines() 63 | 64 | for line_num, line in enumerate(lines): 65 | line = line.strip() 66 | if not line or line.lower().startswith('latitude') or line.lower().startswith('lat'): 67 | continue # Skip headers or empty lines 68 | 69 | parts = line.split(',') 70 | if len(parts) != 2: 71 | messagebox.showwarning("Format Warning", f"Skipping invalid line {line_num + 1}: '{line}'") 72 | continue 73 | 74 | try: 75 | lat = float(parts[0].strip()) 76 | lon = float(parts[1].strip()) 77 | if not (-90 <= lat <= 90): 78 | raise ValueError(f"Latitude {lat} out of range [-90, 90]") 79 | if not (-180 <= lon <= 180): 80 | raise ValueError(f"Longitude {lon} out of range [-180, 180]") 81 | 82 | points.append((lat, lon)) 83 | except ValueError as ve: 84 | messagebox.showwarning("Invalid Data", f"Line {line_num + 1}: Invalid coordinate - {ve}") 85 | 86 | if points: 87 | messagebox.showinfo("Load Success", f"Loaded {len(points)} point(s) from:\n{os.path.basename(file_path)}") 88 | else: 89 | messagebox.showwarning("No Points Loaded", "No valid GPS points found in the file.") 90 | 91 | except Exception as e: 92 | messagebox.showerror("File Error", f"Could not read file: {str(e)}") 93 | 94 | return points 95 | 96 | 97 | # --- GUI with full date/time picker and start/end times in summary --- 98 | def create_gui(): 99 | root = tk.Tk() 100 | root.title("GPS Distance Calculator (Advanced)") 101 | root.geometry("600x750") # Slightly taller for new button 102 | 103 | points = [] # Store all points as [(lat, lon), ...] 104 | travel_hours = 0.0 105 | start_time = None 106 | end_time = None 107 | 108 | def set_travel_hours_from_datetime(): 109 | nonlocal travel_hours, start_time, end_time 110 | try: 111 | start_str = simpledialog.askstring("Start Date & Time", "Enter start time (e.g. 2025-04-05 08:00):") 112 | if not start_str: 113 | return 114 | 115 | end_str = simpledialog.askstring("End Date & Time", "Enter end time (e.g. 2025-04-05 18:00):") 116 | if not end_str: 117 | return 118 | 119 | start_time = datetime.strptime(start_str, "%Y-%m-%d %H:%M") 120 | end_time = datetime.strptime(end_str, "%Y-%m-%d %H:%M") 121 | 122 | if start_time >= end_time: 123 | messagebox.showerror("Error", "End time must be after start time.") 124 | return 125 | 126 | travel_hours = (end_time - start_time).total_seconds() / 3600 127 | 128 | # Update UI 129 | time_label.config(text=f"Travel Time: {travel_hours:.1f} hours") 130 | start_end_label.config(text=f"Start: {start_time.strftime('%Y-%m-%d %H:%M')} | End: {end_time.strftime('%Y-%m-%d %H:%M')}") 131 | except Exception as e: 132 | messagebox.showerror("Error", f"Invalid date/time format. Use YYYY-MM-DD HH:MM. Error: {str(e)}") 133 | 134 | def add_point(): 135 | nonlocal points 136 | try: 137 | point_str = simpledialog.askstring("Add Point", "Enter lat, lon (e.g. 40.7128, -74.0060):") 138 | if not point_str: 139 | return 140 | 141 | lat, lon = map(float, point_str.split(',')) 142 | if not (-90 <= lat <= 90) or not (-180 <= lon <= 180): 143 | messagebox.showerror("Error", "Invalid coordinates. Latitude: -90 to 90, Longitude: -180 to 180.") 144 | return 145 | 146 | points.append((lat, lon)) 147 | messagebox.showinfo("Success", f"Point added: {lat}, {lon}") 148 | 149 | count_label.config(text=f"Points: {len(points)}") 150 | 151 | except Exception as e: 152 | messagebox.showerror("Error", f"Invalid input: {str(e)}") 153 | 154 | def load_points(): 155 | nonlocal points 156 | loaded = load_points_from_file() 157 | if loaded: 158 | points.extend(loaded) 159 | count_label.config(text=f"Points: {len(points)}") 160 | messagebox.showinfo("Update", f"Current route now has {len(points)} total point(s).") 161 | 162 | def calculate_distance(): 163 | nonlocal travel_hours 164 | if len(points) < 2: 165 | messagebox.showerror("Error", "Need at least 2 points to calculate distance.") 166 | return 167 | 168 | # Calculate distances between consecutive points 169 | total_distance = 0.0 170 | coords = [(lat, lon) for lat, lon in points] 171 | 172 | for i in range(len(coords) - 1): 173 | p1 = coords[i] 174 | p2 = coords[i + 1] 175 | dist = geopy.distance.distance(p1, p2).nm 176 | total_distance += dist 177 | 178 | # Calculate average speed in knots 179 | if travel_hours <= 0: 180 | avg_speed = 0 181 | speed_text = "N/A" 182 | else: 183 | avg_speed = total_distance / travel_hours 184 | speed_text = f"{avg_speed:.2f} knots" 185 | 186 | # Build summary 187 | summary = ( 188 | f"Total Distance: {total_distance:.2f} nmi\n" 189 | f"Travel Time: {travel_hours:.1f} hours\n" 190 | f"Average Speed: {avg_speed:.2f} knots" 191 | ) 192 | 193 | messagebox.showinfo("Summary", summary) 194 | 195 | # Create map 196 | m = folium.Map( 197 | location=[(coords[0][0] + coords[-1][0]) / 2, (coords[0][1] + coords[-1][1]) / 2], 198 | zoom_start=5 199 | ) 200 | 201 | # Add markers 202 | for i, (lat, lon) in enumerate(coords): 203 | popup_text = f"Point {i+1}\nLat: {lat:.4f}\nLon: {lon:.4f}" 204 | folium.Marker( 205 | [lat, lon], 206 | popup=popup_text, 207 | icon=folium.Icon(color="blue", icon="info-sign") 208 | ).add_to(m) 209 | 210 | # Add polyline 211 | folium.PolyLine(coords, color="blue", weight=3, opacity=0.8, popup="Route").add_to(m) 212 | 213 | # Summary popup 214 | start_str = start_time.strftime('%Y-%m-%d %H:%M') if start_time else "N/A" 215 | end_str = end_time.strftime('%Y-%m-%d %H:%M') if end_time else "N/A" 216 | summary_html = f""" 217 |
218 | Total Distance: {total_distance:.2f} nmi
219 | Start Time: {start_str}
220 | End Time: {end_str}
221 | Travel Time: {travel_hours:.1f} h
222 | Average Speed: {avg_speed:.2f} knots
223 | Points: {len(points)} total 224 |
225 | """ 226 | 227 | folium.Marker( 228 | coords[0], 229 | popup=folium.Popup(summary_html, max_width=300), 230 | icon=folium.Icon(color="green", icon="info-sign") 231 | ).add_to(m) 232 | 233 | # Open map 234 | threading.Thread(target=open_map_in_browser, args=(m,), daemon=True).start() 235 | 236 | # Save results 237 | save_results_to_file(points, travel_hours, total_distance, avg_speed, start_time, end_time) 238 | 239 | # === UI Elements === 240 | title_label = tk.Label(root, text="GPS Distance Calculator (Advanced)", font=("Arial", 16, "bold")) 241 | title_label.pack(pady=10) 242 | 243 | left_frame = tk.Frame(root, width=500, bg="lightgray") 244 | left_frame.pack(side=tk.LEFT, fill=tk.Y, padx=10, pady=10) 245 | 246 | tk.Label(left_frame, text="Points:", font=("Arial", 12)).pack(anchor="w", padx=10, pady=5) 247 | count_label = tk.Label(left_frame, text="Points: 0", font=("Arial", 12)) 248 | count_label.pack(anchor="w", padx=10, pady=2) 249 | 250 | add_button = tk.Button(left_frame, text="Add Point", command=add_point, bg="lightblue", font=("Arial", 10)) 251 | add_button.pack(pady=5) 252 | 253 | load_button = tk.Button(left_frame, text="Load Points from File", command=load_points, bg="lightgreen", font=("Arial", 10)) 254 | load_button.pack(pady=5) 255 | 256 | # --- Travel Time Input Section --- 257 | tk.Label(left_frame, text="Travel Time (Start & End)", font=("Arial", 12)).pack(anchor="w", padx=10, pady=10) 258 | 259 | tk.Label(left_frame, text="Start Date & Time (YYYY-MM-DD HH:MM):", font=("Arial", 10)).pack(anchor="w", padx=10, pady=2) 260 | tk.Label(left_frame, text="End Date & Time (YYYY-MM-DD HH:MM):", font=("Arial", 10)).pack(anchor="w", padx=10, pady=2) 261 | 262 | time_button = tk.Button(left_frame, text="Set Travel Time from Start/End", command=set_travel_hours_from_datetime, bg="lightgreen", font=("Arial", 10)) 263 | time_button.pack(pady=5) 264 | 265 | time_label = tk.Label(left_frame, text="Travel Time: 0.0 hours", font=("Arial", 12)) 266 | time_label.pack(anchor="w", padx=10, pady=5) 267 | 268 | start_end_label = tk.Label(left_frame, text="Start: N/A | End: N/A", font=("Arial", 10), fg="gray") 269 | start_end_label.pack(anchor="w", padx=10, pady=2) 270 | 271 | calc_button = tk.Button(left_frame, text="Calculate Distance & Show Map", command=calculate_distance, bg="darkblue", fg="white", font=("Arial", 10)) 272 | calc_button.pack(pady=20) 273 | 274 | save_button = tk.Button(left_frame, text="Save Results to File", command=lambda: save_results_to_file(points, travel_hours, 0, 0, start_time, end_time), bg="orange", fg="white", font=("Arial", 10)) 275 | save_button.pack(pady=5) 276 | 277 | note_label = tk.Label(left_frame, text="Note: Travel time is required for speed calculation.", font=("Arial", 9), fg="gray") 278 | note_label.pack(anchor="w", padx=10, pady=5) 279 | 280 | root.mainloop() 281 | 282 | 283 | # --- Run the app --- 284 | if __name__ == "__main__": 285 | create_gui() -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GPS Distance Calculator (Advanced) Documentation 2 | 3 | --- 4 | 5 | ## Packages Requirements 6 | 7 | This application uses several Python packages to provide its functionality. To run the app successfully, ensure the following packages are installed: 8 | 9 | ```bash 10 | pip install tkinter geopy folium 11 | ``` 12 | 13 | > **Note:** `tkinter` is usually included with Python, but for some environments (e.g., headless servers), you may need to install it separately. `geopy` is used for calculating distances between geographic coordinates, and `folium` is used to generate interactive maps. 14 | 15 | --- 16 | 17 | ## How to Run 18 | 19 | 1. Clone the repo`. 20 | 2. Open a terminal or command prompt and navigate to the directory containing the script. 21 | 3. Run the script using: 22 | 23 | ```bash 24 | python GPSnauticalSpeed_rev004.py 25 | ``` 26 | 27 | The GUI window will open, and you can start adding GPS points, setting travel times, and calculating distances. 28 | 29 | 30 | 31 | --- 32 | 33 | ## Description of Classes and Functions 34 | 35 | ### Classes 36 | 37 | - **No classes are defined** in this script. The entire application is implemented using functions and global variables. 38 | 39 | ### Functions 40 | 41 | - **`open_map_in_browser(m)`** 42 | Saves the generated map to a temporary HTML file and opens it in the default web browser. This function avoids opening the map directly in the GUI window, which could interfere with the Tkinter interface. 43 | 44 | - **`save_results_to_file(points, travel_hours, total_distance, avg_speed, start_time, end_time)`** 45 | Saves the GPS data, travel time, total distance, and average speed to a text file in the current working directory. The filename includes a timestamp to avoid overwriting previous results. 46 | 47 | - **`create_gui()`** 48 | The main function that sets up the graphical user interface using `tkinter`. It includes input fields for GPS coordinates, date/time pickers for travel time, and buttons to add points, set travel time, calculate results, and save data. 49 | 50 | - **`set_travel_hours_from_datetime()`** 51 | Prompts the user to input start and end times via `simpledialog`, validates the input, and updates the displayed travel time and time range. 52 | 53 | - **`add_point()`** 54 | Prompts the user to input latitude and longitude for a new GPS point, validates the coordinates, and adds the point to the list. 55 | 56 | - **`calculate_distance()`** 57 | Calculates the total distance between consecutive GPS points, computes average speed, and displays a summary in a popup. It also generates an interactive map using `folium`, placing markers at each point and drawing a polyline between them. The map is opened in a new browser tab via a separate thread to prevent freezing the GUI. 58 | 59 | - **`save_results_to_file(...)`** and **`open_map_in_browser(m)`** 60 | These functions are called from `calculate_distance()` to handle file saving and map opening respectively. 61 | 62 | --- 63 | 64 | ## Description of the App Goal 65 | 66 | The **GPS Distance Calculator (Advanced)** is a desktop application designed to help users calculate the total distance traveled between a series of GPS coordinates, along with the average speed and total travel time. It provides an interactive GUI for inputting GPS points and travel time ranges, and generates a visual map showing the route and distance traveled. 67 | 68 | Key features include: 69 | - Input of GPS coordinates (latitude and longitude) for multiple points. 70 | - Selection of start and end times for travel duration. 71 | - Calculation of total distance, travel time, and average speed. 72 | - Interactive map generation using `folium` showing all points and the route. 73 | - Saving of results to a text file with timestamps for record-keeping. 74 | 75 | This tool is useful for outdoor navigation, tracking travel routes, and analyzing movement patterns. 76 | 77 | --- 78 | 79 | ## Additional Notes 80 | 81 | - The application uses `threading` to open the map in a separate thread, ensuring the GUI remains responsive during map generation. 82 | - Date/time inputs are expected in `YYYY-MM-DD HH:MM` format. 83 | - The map is generated using `folium` and opened in the default web browser, so internet access is required for map display. 84 | - The results are saved in the current working directory with a unique timestamp to prevent overwriting. 85 | 86 | --- 87 | 88 | ## Example Usage 89 | 90 | 1. Run the script. 91 | 2. Click **"Add Point"** and enter coordinates (e.g., `40.7128, -74.0060`). 92 | 3. Set travel time using **"Set Travel Time from Start/End"** (optional). 93 | 4. Click **"Calculate Distance & Show Map"** to see results and map. 94 | 5. Click **"Save Results to File"** to save the data locally. 95 | 96 | --- 97 | ## Additional feature - load from TXT existing routes with GPS points 98 | 99 | > I want to be able to start with an existing list of points: can you add this feature and give me an example of how to prepare the data for this purpose? 100 | 101 | 102 | Absolutely! I'll enhance your app to allow loading an **existing list of GPS points** from a file at startup. This will let users: 103 | 104 | - Save point lists for reuse. 105 | - Load predefined routes (e.g., sailing paths, flight plans). 106 | - Avoid re-entering coordinates every time. 107 | 108 | --- 109 | 110 | ### ✅ New Feature: Load Points from File 111 | 112 | We’ll support a simple **CSV or TXT file** format like this: 113 | 114 | ```csv 115 | latitude,longitude 116 | 40.7128,-74.0060 117 | 34.0522,-118.2437 118 | 41.8781,-87.6298 119 | ``` 120 | 121 | > 💡 The first line is a header (optional), then one point per line: `lat,lon` 122 | 123 | You can name the file anything, e.g., `route1.txt`, `hawaii_voyage.csv`, etc. 124 | 125 | --- 126 | 127 | ### 🔧 Changes Made to Your Code 128 | 129 | I’ve updated your code with: 130 | 1. A **"Load Points" button** in the GUI. 131 | 2. A function `load_points_from_file()` that reads and validates coordinates. 132 | 3. Optional: Warns if any coordinate is invalid but skips or rejects it based on preference. 133 | 134 | --- 135 | 136 | ### ✅ Updated Code (with Load Feature) 137 | 138 | Replace your entire code with this updated version: 139 | 140 | ```python 141 | import tkinter as tk 142 | from tkinter import simpledialog, messagebox, ttk, filedialog 143 | import geopy.distance 144 | import folium 145 | import webbrowser 146 | import os 147 | import threading 148 | from datetime import datetime 149 | import tempfile 150 | 151 | 152 | # --- Safe function to create and open map in browser --- 153 | def open_map_in_browser(m): 154 | temp_dir = tempfile.gettempdir() 155 | html_filename = os.path.join(temp_dir, "gps_distance_map.html") 156 | 157 | try: 158 | m.save(html_filename) 159 | webbrowser.open(f"file://{html_filename}") 160 | print(f"Map saved to {html_filename} and opened in browser.") 161 | except Exception as e: 162 | messagebox.showerror("Error", f"Failed to save or open map: {str(e)}") 163 | 164 | 165 | # --- Save results to file in current directory --- 166 | def save_results_to_file(points, travel_hours, total_distance, avg_speed, start_time, end_time): 167 | current_dir = os.getcwd() 168 | timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S") 169 | filename = f"gps_results_{timestamp}.txt" 170 | 171 | file_path = os.path.join(current_dir, filename) 172 | 173 | try: 174 | with open(file_path, 'w', encoding='utf-8') as f: 175 | f.write("=== GPS Distance Calculation Results ===\n\n") 176 | f.write(f"Generated on: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}\n\n") 177 | f.write(f"Start Time: {start_time.strftime('%Y-%m-%d %H:%M') if start_time else 'N/A'}\n") 178 | f.write(f"End Time: {end_time.strftime('%Y-%m-%d %H:%M') if end_time else 'N/A'}\n") 179 | f.write(f"Travel Time: {travel_hours:.1f} hours\n") 180 | f.write(f"Total Distance: {total_distance:.2f} nautical miles\n") 181 | f.write(f"Average Speed: {avg_speed:.2f} knots\n\n") 182 | f.write("List of Points (Latitude, Longitude):\n") 183 | for i, (lat, lon) in enumerate(points): 184 | f.write(f" Point {i+1}: {lat:.6f}, {lon:.6f}\n") 185 | messagebox.showinfo("Save Success", f"Results saved to:\n{file_path}") 186 | except Exception as e: 187 | messagebox.showerror("Save Error", f"Failed to save file: {str(e)}") 188 | 189 | 190 | # --- Load GPS points from a CSV/TXT file --- 191 | def load_points_from_file(): 192 | file_path = filedialog.askopenfilename( 193 | title="Select GPS Points File", 194 | filetypes=[("Text/CSV Files", "*.txt *.csv"), ("All Files", "*.*")] 195 | ) 196 | if not file_path: 197 | return [] 198 | 199 | points = [] 200 | try: 201 | with open(file_path, 'r', encoding='utf-8') as f: 202 | lines = f.readlines() 203 | 204 | for line_num, line in enumerate(lines): 205 | line = line.strip() 206 | if not line or line.lower().startswith('latitude') or line.lower().startswith('lat'): 207 | continue # Skip headers or empty lines 208 | 209 | parts = line.split(',') 210 | if len(parts) != 2: 211 | messagebox.showwarning("Format Warning", f"Skipping invalid line {line_num + 1}: '{line}'") 212 | continue 213 | 214 | try: 215 | lat = float(parts[0].strip()) 216 | lon = float(parts[1].strip()) 217 | if not (-90 <= lat <= 90): 218 | raise ValueError(f"Latitude {lat} out of range [-90, 90]") 219 | if not (-180 <= lon <= 180): 220 | raise ValueError(f"Longitude {lon} out of range [-180, 180]") 221 | 222 | points.append((lat, lon)) 223 | except ValueError as ve: 224 | messagebox.showwarning("Invalid Data", f"Line {line_num + 1}: Invalid coordinate - {ve}") 225 | 226 | if points: 227 | messagebox.showinfo("Load Success", f"Loaded {len(points)} point(s) from:\n{os.path.basename(file_path)}") 228 | else: 229 | messagebox.showwarning("No Points Loaded", "No valid GPS points found in the file.") 230 | 231 | except Exception as e: 232 | messagebox.showerror("File Error", f"Could not read file: {str(e)}") 233 | 234 | return points 235 | 236 | 237 | # --- GUI with full date/time picker and start/end times in summary --- 238 | def create_gui(): 239 | root = tk.Tk() 240 | root.title("GPS Distance Calculator (Advanced)") 241 | root.geometry("600x750") # Slightly taller for new button 242 | 243 | points = [] # Store all points as [(lat, lon), ...] 244 | travel_hours = 0.0 245 | start_time = None 246 | end_time = None 247 | 248 | def set_travel_hours_from_datetime(): 249 | nonlocal travel_hours, start_time, end_time 250 | try: 251 | start_str = simpledialog.askstring("Start Date & Time", "Enter start time (e.g. 2025-04-05 08:00):") 252 | if not start_str: 253 | return 254 | 255 | end_str = simpledialog.askstring("End Date & Time", "Enter end time (e.g. 2025-04-05 18:00):") 256 | if not end_str: 257 | return 258 | 259 | start_time = datetime.strptime(start_str, "%Y-%m-%d %H:%M") 260 | end_time = datetime.strptime(end_str, "%Y-%m-%d %H:%M") 261 | 262 | if start_time >= end_time: 263 | messagebox.showerror("Error", "End time must be after start time.") 264 | return 265 | 266 | travel_hours = (end_time - start_time).total_seconds() / 3600 267 | 268 | # Update UI 269 | time_label.config(text=f"Travel Time: {travel_hours:.1f} hours") 270 | start_end_label.config(text=f"Start: {start_time.strftime('%Y-%m-%d %H:%M')} | End: {end_time.strftime('%Y-%m-%d %H:%M')}") 271 | except Exception as e: 272 | messagebox.showerror("Error", f"Invalid date/time format. Use YYYY-MM-DD HH:MM. Error: {str(e)}") 273 | 274 | def add_point(): 275 | nonlocal points 276 | try: 277 | point_str = simpledialog.askstring("Add Point", "Enter lat, lon (e.g. 40.7128, -74.0060):") 278 | if not point_str: 279 | return 280 | 281 | lat, lon = map(float, point_str.split(',')) 282 | if not (-90 <= lat <= 90) or not (-180 <= lon <= 180): 283 | messagebox.showerror("Error", "Invalid coordinates. Latitude: -90 to 90, Longitude: -180 to 180.") 284 | return 285 | 286 | points.append((lat, lon)) 287 | messagebox.showinfo("Success", f"Point added: {lat}, {lon}") 288 | 289 | count_label.config(text=f"Points: {len(points)}") 290 | 291 | except Exception as e: 292 | messagebox.showerror("Error", f"Invalid input: {str(e)}") 293 | 294 | def load_points(): 295 | nonlocal points 296 | loaded = load_points_from_file() 297 | if loaded: 298 | points.extend(loaded) 299 | count_label.config(text=f"Points: {len(points)}") 300 | messagebox.showinfo("Update", f"Current route now has {len(points)} total point(s).") 301 | 302 | def calculate_distance(): 303 | nonlocal travel_hours 304 | if len(points) < 2: 305 | messagebox.showerror("Error", "Need at least 2 points to calculate distance.") 306 | return 307 | 308 | # Calculate distances between consecutive points 309 | total_distance = 0.0 310 | coords = [(lat, lon) for lat, lon in points] 311 | 312 | for i in range(len(coords) - 1): 313 | p1 = coords[i] 314 | p2 = coords[i + 1] 315 | dist = geopy.distance.distance(p1, p2).nm 316 | total_distance += dist 317 | 318 | # Calculate average speed in knots 319 | if travel_hours <= 0: 320 | avg_speed = 0 321 | speed_text = "N/A" 322 | else: 323 | avg_speed = total_distance / travel_hours 324 | speed_text = f"{avg_speed:.2f} knots" 325 | 326 | # Build summary 327 | summary = ( 328 | f"Total Distance: {total_distance:.2f} nmi\n" 329 | f"Travel Time: {travel_hours:.1f} hours\n" 330 | f"Average Speed: {avg_speed:.2f} knots" 331 | ) 332 | 333 | messagebox.showinfo("Summary", summary) 334 | 335 | # Create map 336 | m = folium.Map( 337 | location=[(coords[0][0] + coords[-1][0]) / 2, (coords[0][1] + coords[-1][1]) / 2], 338 | zoom_start=5 339 | ) 340 | 341 | # Add markers 342 | for i, (lat, lon) in enumerate(coords): 343 | popup_text = f"Point {i+1}\nLat: {lat:.4f}\nLon: {lon:.4f}" 344 | folium.Marker( 345 | [lat, lon], 346 | popup=popup_text, 347 | icon=folium.Icon(color="blue", icon="info-sign") 348 | ).add_to(m) 349 | 350 | # Add polyline 351 | folium.PolyLine(coords, color="blue", weight=3, opacity=0.8, popup="Route").add_to(m) 352 | 353 | # Summary popup 354 | start_str = start_time.strftime('%Y-%m-%d %H:%M') if start_time else "N/A" 355 | end_str = end_time.strftime('%Y-%m-%d %H:%M') if end_time else "N/A" 356 | summary_html = f""" 357 |
358 | Total Distance: {total_distance:.2f} nmi
359 | Start Time: {start_str}
360 | End Time: {end_str}
361 | Travel Time: {travel_hours:.1f} h
362 | Average Speed: {avg_speed:.2f} knots
363 | Points: {len(points)} total 364 |
365 | """ 366 | 367 | folium.Marker( 368 | coords[0], 369 | popup=folium.Popup(summary_html, max_width=300), 370 | icon=folium.Icon(color="green", icon="info-sign") 371 | ).add_to(m) 372 | 373 | # Open map 374 | threading.Thread(target=open_map_in_browser, args=(m,), daemon=True).start() 375 | 376 | # Save results 377 | save_results_to_file(points, travel_hours, total_distance, avg_speed, start_time, end_time) 378 | 379 | # === UI Elements === 380 | title_label = tk.Label(root, text="GPS Distance Calculator (Advanced)", font=("Arial", 16, "bold")) 381 | title_label.pack(pady=10) 382 | 383 | left_frame = tk.Frame(root, width=500, bg="lightgray") 384 | left_frame.pack(side=tk.LEFT, fill=tk.Y, padx=10, pady=10) 385 | 386 | tk.Label(left_frame, text="Points:", font=("Arial", 12)).pack(anchor="w", padx=10, pady=5) 387 | count_label = tk.Label(left_frame, text="Points: 0", font=("Arial", 12)) 388 | count_label.pack(anchor="w", padx=10, pady=2) 389 | 390 | add_button = tk.Button(left_frame, text="Add Point", command=add_point, bg="lightblue", font=("Arial", 10)) 391 | add_button.pack(pady=5) 392 | 393 | load_button = tk.Button(left_frame, text="Load Points from File", command=load_points, bg="lightgreen", font=("Arial", 10)) 394 | load_button.pack(pady=5) 395 | 396 | # --- Travel Time Input Section --- 397 | tk.Label(left_frame, text="Travel Time (Start & End)", font=("Arial", 12)).pack(anchor="w", padx=10, pady=10) 398 | 399 | tk.Label(left_frame, text="Start Date & Time (YYYY-MM-DD HH:MM):", font=("Arial", 10)).pack(anchor="w", padx=10, pady=2) 400 | tk.Label(left_frame, text="End Date & Time (YYYY-MM-DD HH:MM):", font=("Arial", 10)).pack(anchor="w", padx=10, pady=2) 401 | 402 | time_button = tk.Button(left_frame, text="Set Travel Time from Start/End", command=set_travel_hours_from_datetime, bg="lightgreen", font=("Arial", 10)) 403 | time_button.pack(pady=5) 404 | 405 | time_label = tk.Label(left_frame, text="Travel Time: 0.0 hours", font=("Arial", 12)) 406 | time_label.pack(anchor="w", padx=10, pady=5) 407 | 408 | start_end_label = tk.Label(left_frame, text="Start: N/A | End: N/A", font=("Arial", 10), fg="gray") 409 | start_end_label.pack(anchor="w", padx=10, pady=2) 410 | 411 | calc_button = tk.Button(left_frame, text="Calculate Distance & Show Map", command=calculate_distance, bg="darkblue", fg="white", font=("Arial", 10)) 412 | calc_button.pack(pady=20) 413 | 414 | save_button = tk.Button(left_frame, text="Save Results to File", command=lambda: save_results_to_file(points, travel_hours, 0, 0, start_time, end_time), bg="orange", fg="white", font=("Arial", 10)) 415 | save_button.pack(pady=5) 416 | 417 | note_label = tk.Label(left_frame, text="Note: Travel time is required for speed calculation.", font=("Arial", 9), fg="gray") 418 | note_label.pack(anchor="w", padx=10, pady=5) 419 | 420 | root.mainloop() 421 | 422 | 423 | # --- Run the app --- 424 | if __name__ == "__main__": 425 | create_gui() 426 | ``` 427 | 428 | --- 429 | 430 | ### 📝 How to Prepare Your Data File 431 | 432 | Create a `.txt` or `.csv` file like this: 433 | 434 | #### Example: `my_route.txt` 435 | ```csv 436 | latitude,longitude 437 | 40.7128,-74.0060 438 | 34.0522,-118.2437 439 | 41.8781,-87.6298 440 | 29.7604,-95.3698 441 | ``` 442 | 443 | > You can skip the header if you want: 444 | > 445 | > ``` 446 | > 40.7128,-74.0060 447 | > 34.0522,-118.2437 448 | > ``` 449 | 450 | Save it anywhere on your computer — then use the **"Load Points from File"** button in the app. 451 | 452 | --- 453 | 454 | ### ✅ Tips 455 | 456 | - Use consistent formatting: comma-separated, no extra spaces. 457 | - Validate coordinates before saving the file. 458 | - You can export routes from tools like Google Earth, MarineTraffic, or GPS loggers into this format. 459 | 460 | --- 461 | 462 | > *Documentation READ.ME created with LFM2-2.6b by Liquid AI* 463 | 464 | Prompt used: 465 | ```markdown 466 | Given the following python app, please help me to write a proper Documentation text including: 467 | - packages requirements 468 | - how to run 469 | - description of classes and functions 470 | - description of the app goal 471 | 472 | here the python app: 473 | >```python 474 | > 475 | >``` 476 | ``` 477 | --- 478 | 479 | 480 | --------------------------------------------------------------------------------