Exports

Export flight plans to various pilot, archival, and briefing formats.

Functions

to_excel(plan, filepath, aircraft=None, takeoff_time=None, mission_name='')[source]

Write a full MovingLines-compatible working Excel file.

This produces the 24-column format (A-X) that MovingLines uses as its internal working format, enabling round-tripping between tools.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame from compute_flight_plan().

  • filepath (str) – Output .xlsx path.

  • aircraft – Optional Aircraft object for metadata.

  • takeoff_time (datetime | None) – UTC datetime of takeoff. If None, times are shown as elapsed minutes from 00:00 UTC.

  • mission_name (str) – Campaign / mission name string.

Return type:

None

to_pilot_excel(plan, filepath, aircraft=None, takeoff_time=None, mission_name='', coord_format='DD MM', include_mag_heading=False)[source]

Write a simplified pilot-facing Excel file.

Matches the MovingLines _for_pilots.xlsx format.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame from compute_flight_plan().

  • filepath (str) – Output .xlsx path.

  • aircraft – Optional Aircraft object for metadata (type, tail number).

  • takeoff_time (datetime | None) – UTC datetime of takeoff.

  • mission_name (str) – Campaign / mission name.

  • coord_format (str) – Coordinate display format — one of 'DD MM', 'DD MM SS', 'NDDD MM.SS'.

  • include_mag_heading (bool) – Include a magnetic heading column. Requires the optional geomag package (pip install hyplan[mag]); off by default so the export works in conda-only installs.

Return type:

None

to_kml(plan, filepath, takeoff_time=None, altitude_exaggeration=1.0)[source]

Write a KML (and optionally KMZ) file for Google Earth.

Matches the MovingLines save2kml layout.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .kml or .kmz path.

  • takeoff_time (datetime | None) – Optional UTC takeoff time.

  • altitude_exaggeration (float) – Multiplier for altitude in the KML coordinates (default 1.0 = true scale; MovingLines uses 10).

Return type:

None

to_gpx(plan, filepath, mission_name='', takeoff_time=None)[source]

Write a GPX route file.

Matches the MovingLines save2gpx format.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .gpx path.

  • mission_name (str) – Route name.

  • takeoff_time (datetime | None) – Optional UTC takeoff time.

Return type:

None

to_foreflight_csv(plan, filepath, takeoff_time=None)[source]

Write a ForeFlight-compatible CSV file.

Matches the MovingLines _FOREFLIGHT.csv format. Also writes a companion _FOREFLIGHT_oneline.txt file.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .csv path.

  • takeoff_time (datetime | None) – Optional UTC takeoff time (used for waypoint naming).

Return type:

None

to_honeywell_fms(plan, filepath, takeoff_time=None)[source]

Write a Honeywell FMS-compatible CSV file.

Matches the MovingLines _Honeywell.csv format for Gulfstream III/IV avionics.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .csv path.

  • takeoff_time (datetime | None) – Optional UTC takeoff time (used for waypoint naming).

Return type:

None

to_er2_csv(plan, filepath, takeoff_time=None)[source]

Write an ER-2-compatible CSV file.

Matches the MovingLines ER-2 export format.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .csv path.

  • takeoff_time (datetime | None) – Optional UTC takeoff time.

Return type:

None

to_icartt(plan, filepath, pi_name='', institution='', mission_name='', flight_date=None, aircraft=None, takeoff_time=None, interval_seconds=60.0, revision='RA', revision_comments='RA: Planned flight track - pre-flight', special_comments='', normal_comments='')[source]

Write an ICARTT v1001 file.

Matches the MovingLines save2ict / write_ict format. Data is linearly interpolated along the flight plan at interval_seconds intervals.

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .ict path.

  • pi_name (str) – Principal investigator name.

  • institution (str) – PI institution.

  • mission_name (str) – Campaign name.

  • flight_date (date | None) – Flight date (default today).

  • aircraft – Aircraft object (for platform name).

  • takeoff_time (datetime | None) – UTC takeoff time. If None, Start_UTC begins at 0.

  • interval_seconds (float) – Interpolation interval in seconds (default 60).

  • revision (str) – Revision code (RA, RB, R0, R1, …).

  • revision_comments (str) – Revision description string.

  • special_comments (str) – Additional special comment lines.

  • normal_comments (str) – Additional normal comment lines.

Return type:

None

to_txt(plan, filepath, takeoff_time=None)[source]

Write a plain text waypoint file.

Matches the MovingLines save2txt format. Note: Lon comes before Lat (opposite of the Excel format).

Parameters:
  • plan (GeoDataFrame) – Flight plan GeoDataFrame.

  • filepath (str) – Output .txt path.

  • takeoff_time (datetime | None) – Optional UTC takeoff time.

Return type:

None