windborne 1.1.2__py3-none-any.whl → 1.1.3__py3-none-any.whl

windborne/__init__.py

@@ -14,6 +14,7 @@ from .data_api import (
     get_flying_missions,
     get_mission_launch_site,
     get_predicted_path,
+    get_flight_path
 )
 
 # Import Forecasts API functions
@@ -50,6 +51,7 @@ __all__ = [
     "get_flying_missions",
     "get_mission_launch_site",
     "get_predicted_path",
+    "get_flight_path",
 
     "get_point_forecasts",
     "get_initialization_times",

windborne/cli.py

@@ -14,6 +14,7 @@ from . import (
     get_flying_missions,
     get_mission_launch_site,
     get_predicted_path,
+    get_flight_path,
 
     get_point_forecasts,
     get_initialization_times,
@@ -125,6 +126,11 @@ def main():
     prediction_parser.add_argument('mission_id', help='Mission ID')
     prediction_parser.add_argument('output', nargs='?', help='Output file')
 
+    # Get Flight Path Command
+    flight_path_parser = subparsers.add_parser('flight-path', help='Get traveled flight path')
+    flight_path_parser.add_argument('mission_id', help='Mission ID')
+    flight_path_parser.add_argument('output', nargs='?', help='Output file')
+
     ####################################################################################################################
     # FORECASTS API FUNCTIONS
     ####################################################################################################################
@@ -377,8 +383,18 @@ def main():
     elif args.command == 'predict-path':
         get_predicted_path(
             mission_id=args.mission_id,
-            output_file=args.output
+            output_file=args.output,
+            print_result=(not args.output)
+        )
+
+    elif args.command == 'flight-path':
+        get_flight_path(
+            mission_id=args.mission_id,
+            output_file=args.output,
+            print_result=(not args.output)
         )
+
+
     ####################################################################################################################
     # FORECASTS API FUNCTIONS CALLED
     ####################################################################################################################

windborne/data_api.py

@@ -7,6 +7,7 @@ import json
 from .api_request import make_api_request
 from .observation_formatting import format_little_r, convert_to_netcdf
 from .utils import to_unix_timestamp, save_arbitrary_response, print_table
+from .track_formatting import save_track
 
 DATA_API_BASE_URL = "https://sensor-data.windbornesystems.com/api/v1"
 
@@ -551,6 +552,9 @@ def get_flying_missions(output_file=None, print_results=False):
     url = f"{DATA_API_BASE_URL}/missions.json"
     flying_missions_response = make_api_request(url)
     flying_missions = flying_missions_response.get("missions", [])
+    for mission in flying_missions:
+        if mission.get('number'):
+            mission['name'] = f"W-{mission['number']}"
 
     # Display currently flying missions only if we are in cli and we don't save info in file
     if print_results:
@@ -617,7 +621,8 @@ def get_mission_launch_site(mission_id=None, output_file=None, print_result=Fals
 
     return response.get('launch_site')
 
-def get_predicted_path(mission_id=None, output_file=None):
+
+def get_predicted_path(mission_id=None, output_file=None, print_result=False):
     """
         Fetches the predicted flight path for a given mission.
         Displays currently flying missions if the provided mission ID is invalid.
@@ -625,7 +630,7 @@ def get_predicted_path(mission_id=None, output_file=None):
         Args:
             mission_id (str): The ID of the mission to fetch the prediction for.
             output_file (str): Optional path to save the response data.
-                               If provided, saves the data in CSV format.
+            print_result (bool): Whether to print the results in the CLI.
 
         Returns:
             list: The API response containing the predicted flight path data.
@@ -635,25 +640,70 @@ def get_predicted_path(mission_id=None, output_file=None):
         return
 
     # Check if provided mission ID belong to a flying mission
-    flying_missions_response = get_flying_missions()
-    flying_missions = flying_missions_response.get("missions", [])
+    flying_missions = get_flying_missions()
 
-    if mission_id not in [mission.get("id") for mission in flying_missions]:
+    mission = None
+    for candidate in flying_missions:
+        if candidate.get('id') == mission_id or candidate.get('name') == mission_id:
+            mission = candidate
+            break
+
+    if mission is None:
         print(f"Provided mission ID '{mission_id}' does not belong to a mission that is currently flying.")
 
         # Display currently flying missions
         if flying_missions:
             print("\nCurrently flying missions:\n")
 
-            print_table(flying_missions, keys=['i', 'id', 'name'], headers=['Index', 'Mission ID', 'Mission Name'])
+            print_table(flying_missions, keys=['id', 'name'], headers=['Mission ID', 'Mission Name'])
         else:
             print("No missions are currently flying.")
         return
 
-    url = f"{DATA_API_BASE_URL}/missions/{mission_id}/prediction.json"
+    url = f"{DATA_API_BASE_URL}/missions/{mission.get('id')}/prediction.json"
     response = make_api_request(url)
 
+    if response is None:
+        return
+
     if output_file:
-        save_arbitrary_response(output_file, response, csv_data_key='prediction')
-    
-    return response.get('prediction')
+        name = mission.get('name', mission_id)
+        save_track(output_file, {name: response['prediction']}, time_key='time')
+
+    if print_result:
+        print("Predicted flight path\n")
+        print_table(response['prediction'], keys=['time', 'latitude', 'longitude', 'altitude'], headers=['Time', 'Latitude', 'Longitude', 'Altitude'])
+
+    return response.get('prediction')
+
+
+def get_flight_path(mission_id=None, output_file=None, print_result=False):
+    """
+        Fetches the flight path for a given mission.
+
+        Args:
+            mission_id (str): The ID of the mission to fetch the flight path for.
+            output_file (str): Optional path to save the response data.
+            print_result (bool): Whether to print the results in the CLI.
+
+        Returns:
+            list: The API response containing the flight path.
+    """
+    if not mission_id:
+        print("A mission id is required to get a flight path")
+        return
+
+    url = f"{DATA_API_BASE_URL}/missions/{mission_id}/flight_data.json"
+    response = make_api_request(url)
+
+    if response is None:
+        return
+
+    if output_file:
+        save_track(output_file, {mission_id: response['flight_data']}, time_key='transmit_time')
+
+    if print_result:
+        print("Flight path\n")
+        print_table(response['flight_data'], keys=['transmit_time', 'latitude', 'longitude', 'altitude'], headers=['Time', 'Latitude', 'Longitude', 'Altitude'])
+
+    return response.get('flight_data')

windborne/forecasts_api.py

@@ -1,5 +1,4 @@
 import requests
-import json
 
 from .utils import (
     parse_time,
@@ -7,22 +6,14 @@ from .utils import (
     print_table
 )
 
-from .api_request import (
-    make_api_request
-)
-
-from .cyclone_formatting import (
-    save_track_as_geojson,
-    save_track_as_gpx,
-    save_track_as_kml,
-    save_track_as_little_r
-)
+from .api_request import make_api_request
+from .track_formatting import save_track
 
 FORECASTS_API_BASE_URL = "https://forecasts.windbornesystems.com/api/v1"
 FORECASTS_GRIDDED_URL = f"{FORECASTS_API_BASE_URL}/gridded"
 FORECASTS_HISTORICAL_URL = f"{FORECASTS_API_BASE_URL}/gridded/historical"
 FORECASTS_TCS_URL = f"{FORECASTS_API_BASE_URL}/tropical_cyclones"
-TCS_SUPPORTED_FORMATS = ('.csv', '.json', '.geojson', '.gpx', '.kml', 'little_r')
+TCS_SUPPORTED_FORMATS = ('.csv', '.json', '.geojson', '.gpx', '.kml', '.little_r')
 
 
 # Point forecasts
@@ -263,11 +254,7 @@ def get_tropical_cyclones(initialization_time=None, basin=None, output_file=None
     response = make_api_request(FORECASTS_TCS_URL, params=params)
 
     if output_file:
-        if '.' not in output_file:
-            print("You have to provide a filetype for your output file.")
-            print_tc_supported_formats()
-            exit (4)
-        elif not output_file.lower().endswith(TCS_SUPPORTED_FORMATS):
+        if not output_file.lower().endswith(TCS_SUPPORTED_FORMATS):
             print("Unsupported file format.")
             print_tc_supported_formats()
             exit(44)
@@ -276,37 +263,14 @@ def get_tropical_cyclones(initialization_time=None, basin=None, output_file=None
             # make_api_request covers 403, 404, 502, HTTP, Connections Errors
             # If we pass all of these and we get an empty dictionary ==> there are no active TCs
             print("There are no active tropical cyclones for your request\n")
-            print("We didn't save any file on your machine.")
             # It's pointless to save an empty file
             # save_response_to_file() will throw error on saving {}
         elif response is None:
             print("-------------------------------------------------------")
             print("You are too quick!\nThe tropical cyclone data for initialization time are not uploaded yet.")
-            print('You may check again in a few hours again.')
-        elif output_file.lower().endswith('.csv'):
-            # Flatten for CSV
-            flattened_data = []
-            for cyclone_id, tracks in response.items():
-                for track in tracks:
-                    track_data = {
-                        'cyclone_id': cyclone_id,
-                        'latitude': track['latitude'],
-                        'longitude': track['longitude'],
-                        'time': track['time']
-                    }
-                    flattened_data.append(track_data)
-            save_arbitrary_response(output_file, {'prediction': flattened_data}, csv_data_key='prediction')
-        elif output_file.lower().endswith('.json'):
-            # Direct save for JSON
-            save_arbitrary_response(output_file, response)
-        elif output_file.lower().endswith('.geojson'):
-            save_track_as_geojson(output_file, response)
-        elif output_file.lower().endswith('.gpx'):
-            save_track_as_gpx(output_file, response)
-        elif output_file.lower().endswith('.kml'):
-            save_track_as_kml(output_file, response)
-        elif output_file.lower().endswith('.little_r'):
-            save_track_as_little_r(output_file, response)
+            print('You may check again in a few hour.')
+        else:
+            save_track(output_file, response, require_ids=True)
 
     if print_response:
         if len(response) == 0:

windborne/{cyclone_formatting.py → track_formatting.py}

@@ -1,15 +1,69 @@
-from datetime import datetime, timezone
+from datetime import datetime
+import json
 
+TRACK_SUPPORTED_FORMATS = ['.csv', '.json', '.geojson', '.gpx', '.kml', 'little_r']
 
-def save_track_as_little_r(filename, cyclone_data):
+def save_track(output_file, track_data, time_key='time', require_ids=False):
     """
-    Convert and save cyclone data in little_R format.
+    Save track data to a file in the specified format.
+    Expects track_data to be a dictionary with cyclone/mission IDs as keys and lists of track points as values.
     """
+    include_id = require_ids or len(track_data) > 1
+
+    if output_file.lower().endswith('.json'):
+        with open(output_file, 'w', encoding='utf-8') as f:
+            json.dump(track_data, f, indent=4)
+    elif output_file.lower().endswith('.csv'):
+        save_track_as_csv(output_file, track_data, time_key=time_key, include_id=include_id)
+    elif output_file.lower().endswith('.geojson'):
+        save_track_as_geojson(output_file, track_data, time_key=time_key)
+    elif output_file.lower().endswith('.gpx'):
+        save_track_as_gpx(output_file, track_data, time_key=time_key)
+    elif output_file.lower().endswith('.kml'):
+        save_track_as_kml(output_file, track_data)
+    elif output_file.lower().endswith('.little_r'):
+        save_track_as_little_r(output_file, track_data, time_key=time_key)
+    else:
+        print(f"Unsupported file format. Supported formats are: {', '.join(TRACK_SUPPORTED_FORMATS)}")
+        return
+
+
+def save_track_as_csv(filename, track_data, time_key='time', include_id=False):
+    """
+    Convert and save track data as CSV.
+    """
+    flattened_data = []
+    for name, tracks in track_data.items():
+        for track in tracks:
+            track_data = {
+                'id': name,
+                'latitude': track['latitude'],
+                'longitude': track['longitude'],
+                'time': track[time_key]
+            }
+            flattened_data.append(track_data)
+
     with open(filename, 'w', encoding='utf-8') as f:
-        for cyclone_id, tracks in cyclone_data.items():
+        if include_id:
+            f.write('id,latitude,longitude,time\n')
+        else:
+            f.write('latitude,longitude,time\n')
+
+        for row in flattened_data:
+            if include_id:
+                f.write(f"{row['id']},{row['latitude']},{row['longitude']},{row['time']}\n")
+            else:
+                f.write(f"{row['latitude']},{row['longitude']},{row['time']}\n")
+
+def save_track_as_little_r(filename, track_data, time_key='time'):
+    """
+    Convert and save track data in little_R format.
+    """
+    with open(filename, 'w', encoding='utf-8') as f:
+        for cyclone_id, tracks in track_data.items():
             for track in tracks:
                 # Parse the time
-                dt = datetime.fromisoformat(track['time'].replace('Z', '+00:00'))
+                dt = datetime.fromisoformat(track[time_key].replace('Z', '+00:00'))
 
                 # Header line 1
                 header1 = f"{float(track['latitude']):20.5f}{float(track['longitude']):20.5f}{'HMS':40}"
@@ -35,21 +89,20 @@ def save_track_as_little_r(filename, cyclone_data):
     print("Saved to", filename)
 
 
-def save_track_as_kml(filename, cyclone_data):
+def save_track_as_kml(filename, track_data):
     """
-    Convert and save cyclone data as KML, handling meridian crossing.
+    Convert and save track data as KML, handling meridian crossing.
     """
     kml = '<?xml version="1.0" encoding="UTF-8"?>\n'
     kml += '<kml xmlns="http://www.opengis.net/kml/2.2">\n<Document>\n'
 
-    for cyclone_id, tracks in cyclone_data.items():
-        kml += f'  <Placemark>\n    <name>{cyclone_id}</name>\n    <MultiGeometry>\n'
+    for id, tracks in track_data.items():
+        kml += f'  <Placemark>\n    <name>{id}</name>\n    <MultiGeometry>\n'
 
         current_segment = []
 
         for i in range(len(tracks)):
             lon = float(tracks[i]['longitude'])
-            lat = float(tracks[i]['latitude'])
 
             if not current_segment:
                 current_segment.append(tracks[i])
@@ -61,7 +114,7 @@ def save_track_as_kml(filename, cyclone_data):
             if abs(lon - prev_lon) > 180:
                 # Write the current segment
                 kml += '      <LineString>\n        <coordinates>\n'
-                coordinates = [f'          {track["longitude"]},{track["latitude"]},{0}'
+                coordinates = [f'          {track["longitude"]},{track["latitude"]},{track.get("altitude", 0)}'
                                for track in current_segment]
                 kml += '\n'.join(coordinates)
                 kml += '\n        </coordinates>\n      </LineString>\n'
@@ -74,7 +127,7 @@ def save_track_as_kml(filename, cyclone_data):
         # Write the last segment if it's not empty
         if current_segment:
             kml += '      <LineString>\n        <coordinates>\n'
-            coordinates = [f'          {track["longitude"]},{track["latitude"]},{0}'
+            coordinates = [f'          {track["longitude"]},{track["latitude"]},{track.get("altitude", 0)}'
                            for track in current_segment]
             kml += '\n'.join(coordinates)
             kml += '\n        </coordinates>\n      </LineString>\n'
@@ -88,12 +141,12 @@ def save_track_as_kml(filename, cyclone_data):
     print(f"Saved to {filename}")
 
 
-def save_track_as_gpx(filename, cyclone_data):
-    """Convert and save cyclone data as GPX, handling meridian crossing."""
+def save_track_as_gpx(filename, track_data, time_key='time'):
+    """Convert and save track data as GPX, handling meridian crossing."""
     gpx = '<?xml version="1.0" encoding="UTF-8"?>\n'
     gpx += '<gpx version="1.1" creator="Windborne" xmlns="http://www.topografix.com/GPX/1/1">\n'
 
-    for cyclone_id, tracks in cyclone_data.items():
+    for cyclone_id, tracks in track_data.items():
         gpx += f'  <trk>\n    <name>{cyclone_id}</name>\n'
 
         current_segment = []
@@ -101,7 +154,6 @@ def save_track_as_gpx(filename, cyclone_data):
 
         for i in range(len(tracks)):
             lon = float(tracks[i]['longitude'])
-            lat = float(tracks[i]['latitude'])
 
             if not current_segment:
                 current_segment.append(tracks[i])
@@ -130,7 +182,7 @@ def save_track_as_gpx(filename, cyclone_data):
             gpx += '    <trkseg>\n'
             for point in current_segment:
                 gpx += f'      <trkpt lat="{point["latitude"]}" lon="{point["longitude"]}">\n'
-                gpx += f'        <time>{point["time"]}</time>\n'
+                gpx += f'        <time>{point[time_key]}</time>\n'
                 gpx += '      </trkpt>\n'
             gpx += '    </trkseg>\n'
 
@@ -143,10 +195,10 @@ def save_track_as_gpx(filename, cyclone_data):
     print(f"Saved to {filename}")
 
 
-def save_track_as_geojson(filename, cyclone_data):
-    """Convert and save cyclone data as GeoJSON, handling meridian crossing."""
+def save_track_as_geojson(filename, track_data, time_key='time'):
+    """Convert and save track data as GeoJSON, handling meridian crossing."""
     features = []
-    for cyclone_id, tracks in cyclone_data.items():
+    for id, tracks in track_data.items():
         # Initialize lists to store line segments
         line_segments = []
         current_segment = []
@@ -188,9 +240,9 @@ def save_track_as_geojson(filename, cyclone_data):
         feature = {
             "type": "Feature",
             "properties": {
-                "cyclone_id": cyclone_id,
-                "start_time": tracks[0]['time'],
-                "end_time": tracks[-1]['time']
+                "id": id,
+                "start_time": tracks[0][time_key],
+                "end_time": tracks[-1][time_key]
             },
             "geometry": {
                 "type": "MultiLineString",

{windborne-1.1.2.dist-info → windborne-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: windborne
-Version: 1.1.2
+Version: 1.1.3
 Summary: A Python library for interacting with WindBorne Data and Forecasts API
 Author-email: WindBorne Systems <data@windbornesystems.com>
 Classifier: Programming Language :: Python :: 3

windborne-1.1.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+windborne/__init__.py,sha256=DcxmiLq4UnjoRjZd4UeuYt29FBsi9paMXGtI91Itn04,1826
+windborne/api_request.py,sha256=zh1TaaZAaRfAXp2NYMja75fKeduWLfao02JRRFVpQCA,11108
+windborne/cli.py,sha256=xRPRLh50iC4Uu0AYEHL-LHRxUnpxqB_Mn-easp5VSK4,35370
+windborne/data_api.py,sha256=QsG1NJyOCzTrTLRaoz5Z4nGRI0HCMEJvbDyRUlY3Usg,31388
+windborne/forecasts_api.py,sha256=E0X9FyUW2yz3pQZKkFBYDMeg6PhFJ1bp4z1Cg1g0uGs,13987
+windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
+windborne/track_formatting.py,sha256=LaLfTyjpWoOtHmReJPLViY0MKm_iPL_5I2OB_lNvGGA,10054
+windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
+windborne-1.1.3.dist-info/METADATA,sha256=unPmA3uPzt8obgqSmJSrsSzSLat4yH7o3uJtb-i3wy0,1235
+windborne-1.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+windborne-1.1.3.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
+windborne-1.1.3.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
+windborne-1.1.3.dist-info/RECORD,,

windborne-1.1.2.dist-info/RECORD

@@ -1,13 +0,0 @@
-windborne/__init__.py,sha256=0bPtPzBG3djZMVfyUNhapiEqCSyN8SSDsm_eCZ4kwhc,1783
-windborne/api_request.py,sha256=zh1TaaZAaRfAXp2NYMja75fKeduWLfao02JRRFVpQCA,11108
-windborne/cli.py,sha256=XvI9a9mO921a_LpI1ojN9Rn_x3sYq3XTkmUUT37wg4g,34835
-windborne/cyclone_formatting.py,sha256=0S8S_PflRGm6ftUlyR2aGGyX6IRn0hbUTEWptu7f8Q8,7886
-windborne/data_api.py,sha256=qVA0UGcnkBGYe8TFgqgFlFjZYCsS4ly1IL97tSpgKgI,29751
-windborne/forecasts_api.py,sha256=QzdayDr3MaswsFibOdBoo6SCdRY86eE2E7kWqn-Jc1Y,15479
-windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
-windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
-windborne-1.1.2.dist-info/METADATA,sha256=NR1lkRL5m-j3UoWVj_2ti14bSrIXZLtCbwS4DfUvko0,1235
-windborne-1.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-windborne-1.1.2.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
-windborne-1.1.2.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
-windborne-1.1.2.dist-info/RECORD,,