API Reference

Optimization

Optimizer(origin_icao, dest_icao, ...[, ...])	Trajectory optimizer based on the PS model with optional climate cost function.
DAGResult(*, state, amass_init, trip_fuel, ...)	The output of Optimizer.solve().
DAGState(*, best_cost, best_mass, best_time, ...)	Working arrays for the wavefront dynamic program.
solve_dag(dag, amass_init, fl_choices, ...)	Solve shortest-path DP on the HorizontalDAG, tracking mass exactly.
solve_track(dag, profile, amass_init, ...)	Solve the vertical profile along a fixed track, choosing the flight level and Mach number.
cruise_flight_levels(origin_icao, dest_icao)	Determine the candidate cruise flight levels for a given origin-destination pair.
estimate_flight_hours(origin, dest[, ...])	Estimate an upper-bound for flight duration in hours.

Geometry

AirportCoords(*, icao_code, longitude, ...)	Coordinates and elevation of an airport, identified by ICAO code.
HorizontalDAG(*, lon, lat, adj_ptr, adj, ...)	Directed graph on (lon, lat) nodes with CSR adjacency.
EdgeInterpolation(*, air_temperature, ...)	Met fields interpolated at sample points.
EdgeMetLookup(*, ds, edge_ptr, edge_idx, ...)	Pre-interpolated met data on edge sample points.
Track(*, lon, lat, node_time)	An ordered sequence of timed waypoints along a flown path.
slerp	Spherical geometry helpers using SLERP (Spherical Linear intERPolation).

Utilities

fill_nan_spatial(ds)	Fill NaN in gridded met with the value at the nearest valid horizontal neighbor.
load_faa_waypoints([refresh_cache])	Load FAA FIX waypoints with CACHE_MAX_AGE cache refresh.
validate_flight_profile(ds, n_nodes)	Validate and format a (waypoint, altitude_ft) flight profile for the track solver.