AEIC

Getting started

  • Getting Started
    • Installation
    • Units

AEIC modules

  • System configuration
    • File paths
    • Configuration initialization and access
    • Configuration uniqueness and immutability
    • Main configuration class
      • Config
        • Config.data_file_location
        • Config.data_path_overrides
        • Config.default_data_file_location
        • Config.default_data_path
        • Config.emissions
        • Config.engine_file
        • Config.escape
        • Config.file_location
        • Config.get
        • Config.load
        • Config.normalize_search_paths
        • Config.path
        • Config.performance_model
        • Config.reset
        • Config.weather
    • Emissions module configuration classes
      • EmissionsConfig
        • EmissionsConfig.DEFAULT_METHOD_HCCO
        • EmissionsConfig.DEFAULT_METHOD_NOx
        • EmissionsConfig.apu_enabled
        • EmissionsConfig.climb_descent_mode
        • EmissionsConfig.co2_enabled
        • EmissionsConfig.co_enabled
        • EmissionsConfig.co_method
        • EmissionsConfig.fuel
        • EmissionsConfig.fuel_file
        • EmissionsConfig.gse_enabled
        • EmissionsConfig.h2o_enabled
        • EmissionsConfig.hc_enabled
        • EmissionsConfig.hc_method
        • EmissionsConfig.lifecycle_enabled
        • EmissionsConfig.nox_enabled
        • EmissionsConfig.nox_method
        • EmissionsConfig.nvpm_enabled
        • EmissionsConfig.nvpm_method
        • EmissionsConfig.sox_enabled
      • ClimbDescentMode
        • ClimbDescentMode.TRAJECTORY
        • ClimbDescentMode.LTO
      • EINOxMethod
        • EINOxMethod.BFFM2
        • EINOxMethod.P3T3
        • EINOxMethod.NONE
      • EInvPMMethod
        • EInvPMMethod.MEEM
        • EInvPMMethod.NONE
    • Weather module configuration class
      • WeatherConfig
        • WeatherConfig.data_resolution
        • WeatherConfig.effective_data_resolution
        • WeatherConfig.effective_file_format
        • WeatherConfig.file_format
        • WeatherConfig.file_resolution
        • WeatherConfig.use_weather
        • WeatherConfig.weather_data_dir
      • TemporalResolution
        • TemporalResolution.HOURLY
        • TemporalResolution.DAILY
        • TemporalResolution.MONTHLY
        • TemporalResolution.ANNUAL
      • default_file_format
      • resolution_le
  • CLI reference
    • aeic run
      • Command-line options
      • Single-process example
      • Parallel example
    • aeic merge-stores
      • Command-line options
      • Example
    • aeic make-file-bundle
      • Command-line options
      • Example
  • Performance models
    • Performance model API
      • Loading performance models
      • Mission-based performance model selection
      • Performance evaluation
      • Usage example
      • Performance model members
      • API reference
        • BasePerformanceModel
        • PerformanceModel
        • PerformanceModelSelector
        • SimplePerformanceModelSelector
        • AircraftState
        • Performance
        • SimpleFlightRules
        • LTOPerformance
        • ThrustMode
        • APU
        • Speeds
        • SpeedData
    • Legacy performance model
      • Input file format
      • Performance table
      • Performance evaluation
      • API reference
        • LegacyPerformanceModel
        • PerformanceTable
        • ROCDFilter
        • Interpolator
        • PerformanceTableInput
    • Performance model files
      • Creating performance model files
      • Example file
  • Trajectories
    • Trajectory data
      • BASE_FIELDS
      • EMISSIONS_FIELDS
      • Trajectory
        • Trajectory.__init__
        • Trajectory.append
        • Trajectory.compare
        • Trajectory.copy_point
        • Trajectory.interpolate_time
        • Trajectory.nbytes
        • Trajectory.set_phase
      • Field sets
        • BASE_FIELDSET_NAME
        • FieldMetadata
        • FieldSet
        • Dimension
        • Dimensions
      • Flight phases
        • FlightPhase
        • FlightPhases
        • PHASE_FIELDS
        • REQUIRED_PHASES
      • Ground tracks
        • GroundTrack
    • Trajectory builders
      • Builder
        • Builder.options
        • Builder.CONTEXT_CLASS
        • Builder.calc_starting_mass
        • Builder.fly
      • Legacy trajectory builder
        • LegacyBuilder
        • LegacyContext
        • LegacyOptions
      • Adjustable legacy trajectory builder
        • Adjustment arguments
        • Validation and clamping
      • Work-in-progress builders
        • TASOPT builder
        • ADS-B builder
        • Dymos builder
    • Trajectory stores
      • TrajectoryStore
        • TrajectoryStore.FileMode
        • TrajectoryStore.NcFiles
        • TrajectoryStore.active_in_thread
        • TrajectoryStore.add
        • TrajectoryStore.add_comment
        • TrajectoryStore.append
        • TrajectoryStore.close
        • TrajectoryStore.combine
        • TrajectoryStore.create
        • TrajectoryStore.create_associated
        • TrajectoryStore.files
        • TrajectoryStore.get_flight
        • TrajectoryStore.iter_flight_ids
        • TrajectoryStore.iter_range
        • TrajectoryStore.merge
        • TrajectoryStore.nc_linked
        • TrajectoryStore.open
        • TrajectoryStore.reproducibility_data
        • TrajectoryStore.save
        • TrajectoryStore.set_sampling_info
        • TrajectoryStore.sync
  • Emissions module
    • Usage example
    • Computation workflow
      • compute_emissions
    • Types
      • Chemical species
        • Species
      • Emissions output
        • Emissions
        • SpeciesValues
        • ThrustModeValues
    • Helper functions
      • get_trajectory_emissions
      • get_LTO_emissions
      • get_APU_emissions
      • get_GSE_emissions
      • EI_SOx
      • SOxEmissionResult
      • EI_HCCO
      • BFFM2EINOxResult
      • BFFM2_EINOx
      • NOXSpeciation
        • NOXSpeciation.hono
        • NOXSpeciation.no
        • NOXSpeciation.no2
      • calculate_nvPM_scope11_LTO
      • nvPMProfileLTO
      • nvPMProfileTrajectory
      • nvPM_MEEM
      • constant_species_values
      • get_SLS_equivalent_fuel_flow
      • get_thrust_cat_cruise
  • BADA methods
    • Engine and fuel burn models
      • Bada3EngineModel
        • Bada3EngineModel.calculate_descent_thrust_app
        • Bada3EngineModel.calculate_descent_thrust_high
        • Bada3EngineModel.calculate_descent_thrust_land
        • Bada3EngineModel.calculate_descent_thrust_low
        • Bada3EngineModel.calculate_max_climb_thrust
        • Bada3EngineModel.calculate_max_cruise_thrust
      • Bada3JetEngineModel
        • Bada3JetEngineModel.calculate_cruise_fuel_flow
        • Bada3JetEngineModel.calculate_max_climb_thrust_isa
        • Bada3JetEngineModel.calculate_nominal_fuel_flow
        • Bada3JetEngineModel.calculate_specific_fuel_consumption
      • Bada3TurbopropEngineModel
        • Bada3TurbopropEngineModel.calculate_cruise_fuel_flow
        • Bada3TurbopropEngineModel.calculate_max_climb_thrust_isa
        • Bada3TurbopropEngineModel.calculate_nominal_fuel_flow
        • Bada3TurbopropEngineModel.calculate_specific_fuel_consumption
      • Bada3PistonEngineModel
        • Bada3PistonEngineModel.calculate_cruise_fuel_flow
        • Bada3PistonEngineModel.calculate_max_climb_thrust_isa
        • Bada3PistonEngineModel.calculate_nominal_fuel_flow
        • Bada3PistonEngineModel.calculate_specific_fuel_consumption
      • Bada3FuelBurnModel
        • Bada3FuelBurnModel.calculate_cd
        • Bada3FuelBurnModel.calculate_cl
        • Bada3FuelBurnModel.calculate_drag
        • Bada3FuelBurnModel.calculate_specific_ground_range
        • Bada3FuelBurnModel.calculate_thrust
        • Bada3FuelBurnModel.calculate_thrust_by_total_energy
        • Bada3FuelBurnModel.iterate_flight_simulation_constant_final_mass
        • Bada3FuelBurnModel.iterate_flight_simulation_constant_initial_mass
        • Bada3FuelBurnModel.iterate_flight_simulation_fuel_burn_dependent_initial_mass_rf_fraction
        • Bada3FuelBurnModel.iterate_flight_simulation_fuel_burn_dependent_initial_mass_rf_value
    • Aircraft parameters
      • Bada3AircraftParameters
        • Bada3AircraftParameters.assign_parameters_fromdict
        • Bada3AircraftParameters.get_params_asdict
    • Fuel burn base classes
      • BaseAircraftParameters
      • BaseFuelBurnModel
    • Helper functions
      • get_aircraft_params_for_all_aircraft_types
      • get_all_available_aircraft_types
      • get_directly_available_aircraft_types
      • get_models_for_all_implemented_aircraft_types
      • read_synonym_file_to_dict
  • Gridding module
    • The trajectories-to-grid command
      • Command-line options
      • Map mode
      • Reduce mode
    • Grid definition files
      • Horizontal axes
      • Vertical axis
      • Examples
    • Filtering trajectories
    • Map-reduce architecture
      • Map phase
      • Reduce phase
    • Parallel execution
      • Example with GNU parallel
      • SLURM job arrays
    • Output format
      • Dimensions
      • Coordinate variables
      • Species variables
      • Reproducibility provenance
    • API reference
      • Grid classes
        • Grid
        • LatitudeGrid
        • LongitudeGrid
        • HeightGrid
        • ISAPressureGrid
      • Output
        • OutputGrid
  • Missions
    • Mission
      • Mission.aircraft_type
      • Mission.arrival
      • Mission.carrier
      • Mission.departure
      • Mission.destination
      • Mission.destination_country
      • Mission.destination_position
      • Mission.engine_type
      • Mission.flight_id
      • Mission.flight_number
      • Mission.from_toml
      • Mission.gc_distance
      • Mission.label
      • Mission.load_factor
      • Mission.origin
      • Mission.origin_country
      • Mission.origin_position
      • Mission.seat_capacity
      • Mission.service_type
  • Mission database
    • Usage example
    • Reference documentation
      • Database class
        • Database
      • Queries
        • Base query class
        • Scheduled flight queries
        • Frequent flights queries
        • Count queries
        • Time-range queries
      • Filters
        • Filter
    • Database schema
  • OAG flight data
    • Database creation
      • Input record filtering
      • File sizes
  • Available parsers
    • PTF reader
      • ClimbPhaseData
        • ClimbPhaseData.fl
        • ClimbPhaseData.fuel_flow_nom
        • ClimbPhaseData.rocd_high
        • ClimbPhaseData.rocd_low
        • ClimbPhaseData.rocd_nom
        • ClimbPhaseData.tas
      • CruisePhaseData
        • CruisePhaseData.fl
        • CruisePhaseData.fuel_flow_high
        • CruisePhaseData.fuel_flow_low
        • CruisePhaseData.fuel_flow_nom
        • CruisePhaseData.tas
      • DescentPhaseData
        • DescentPhaseData.fl
        • DescentPhaseData.fuel_flow_nom
        • DescentPhaseData.rocd_nom
        • DescentPhaseData.tas
      • PTFData
        • PTFData.isa_offset
        • PTFData.load
    • OPF reader
      • parse_OPF
    • LTO reader
      • parseLTO
  • Storage module
    • API reference
      • Container
        • Container.CAPACITY_EXPANSION
        • Container.STARTING_CAPACITY
        • Container.add_fields
        • Container.approx_eq
        • Container.copy
        • Container.fix
        • Container.make_point
        • Container.species
      • Dimension
        • Dimension.TRAJECTORY
        • Dimension.SPECIES
        • Dimension.POINT
        • Dimension.THRUST_MODE
        • Dimension.dim_name
        • Dimension.from_dim_name
      • FieldMetadata
        • FieldMetadata.convert_in
        • FieldMetadata.default
        • FieldMetadata.description
        • FieldMetadata.digest_info
        • FieldMetadata.dimensions
        • FieldMetadata.empty
        • FieldMetadata.field_type
        • FieldMetadata.nbytes
        • FieldMetadata.required
        • FieldMetadata.units
      • FieldSet
        • FieldSet.REGISTRY
        • FieldSet.calc_hash
        • FieldSet.digest
        • FieldSet.dimensions
        • FieldSet.fields
        • FieldSet.from_netcdf_group
        • FieldSet.from_registry
        • FieldSet.known
        • FieldSet.merge
        • FieldSet.single_point
      • FlightPhase
        • FlightPhase.IDLE_ORIGIN
        • FlightPhase.TAXI_ORIGIN
        • FlightPhase.TAKEOFF
        • FlightPhase.CLIMB
        • FlightPhase.CRUISE
        • FlightPhase.DESCENT
        • FlightPhase.APPROACH
        • FlightPhase.TAXI_DESTINATION
        • FlightPhase.IDLE_DESTINATION
        • FlightPhase.field_name
        • FlightPhase.method_name
        • FlightPhase.field_label
        • FlightPhase.from_field_name
      • HasFieldSets
      • ReproducibilityData
        • ReproducibilityData.config
        • ReproducibilityData.files
        • ReproducibilityData.git_branch
        • ReproducibilityData.git_commit
        • ReproducibilityData.git_dirty
        • ReproducibilityData.python_version
        • ReproducibilityData.sample_fraction
        • ReproducibilityData.sample_seed
        • ReproducibilityData.software_version
        • ReproducibilityData.union
      • track_file_accesses
  • Utilities
    • Custom types
      • Location
        • Location.latitude
        • Location.longitude
      • Position
        • Position.altitude
        • Position.latitude
        • Position.location
        • Position.longitude
      • DayOfWeek
        • DayOfWeek.from_pandas
      • TimeOfDay
        • TimeOfDay.hour
        • TimeOfDay.minute
      • AircraftClass
        • AircraftClass.WIDE
        • AircraftClass.NARROW
        • AircraftClass.SMALL
        • AircraftClass.FREIGHT
      • FloatOrNDArray
    • Airport handling
      • Airport
        • Airport.country
        • Airport.elevation
        • Airport.iata_code
        • Airport.latitude
        • Airport.longitude
        • Airport.municipality
        • Airport.name
        • Airport.position
      • AirportsData
      • CountriesData
      • Country
        • Country.code
        • Country.continent
        • Country.name
      • airport
      • country
    • Unit conversion
      • FEET_TO_METERS
      • FL_TO_METERS
      • FPM_TO_MPS
      • KG_TO_GRAMS
      • KNOTS_TO_MPS
      • METERS_TO_FEET
      • METERS_TO_FL
      • MINUTES_TO_SECONDS
      • MPS_TO_KNOTS
      • NAUTICAL_MILES_TO_METERS
      • PPM
      • STATUTE_MILES_TO_KM
    • Geospatial utilities
      • GEOD
    • File handling functions
      • download
    • Standard atmosphere
      • altitude_from_pressure_isa_bada4
      • calculate_air_density
      • calculate_speed_of_sound
      • pressure_at_altitude_isa_bada4
      • speed_of_sound_at_altitude
      • temperature_at_altitude_isa_bada4
    • Fuel
      • Fuel
        • Fuel.EI_CO2
        • Fuel.EI_H2O
        • Fuel.energy_MJ_per_kg
        • Fuel.fuel_sulfur_content_nom
        • Fuel.lifecycle_CO2
        • Fuel.model_config
        • Fuel.name
        • Fuel.non_volatile_carbon_fraction
        • Fuel.sulfate_yield_nom
    • Data modeling utility classes
      • CIBaseModel
        • CIBaseModel.model_config
      • CIStrEnum
  • Weather
    • Class members
      • Weather
        • Weather.get_ground_speed

Developer documentation

  • Setup and tools
    • Project setup and dependency management
    • Local Development
    • uv
    • pre-commit
    • Testing
  • Conventions
    • Coding standards
    • Units
    • Data dictionary
  • Releases
  • Grid map phase optimization report
    • Summary
      • Unfiltered path
      • Filtered path
    • Step 1: eliminate redundant scalar reads in _read_from_nc_var
      • The problem
      • The fix
    • Step 2: batched slab reads via iter_range
      • The problem
      • The fix
    • Step 3: skip type-checking on trusted internal reads
      • The problem
      • The fix
    • Step 4: bulk index lookup and batched reads via iter_flight_ids
      • The problem
      • The fix
    • Lessons: avoiding NetCDF performance bugs
      • 1. Every var[index] is expensive – never read the same index twice
      • 2. Prefer slab reads over scalar loops
      • 3. Watch out for negative indexing in slices
      • 4. Profile before optimizing
      • 5. Validation has a cost – bypass it on trusted internal paths
      • 6. Understand the library stack beneath you
      • 7. Collect all IDs before entering a read loop
AEIC
  • Search

© Copyright 2025, Wyatt Giroux, Prashanth Prakash, Prateek Ranjan, Aditeya Shukla, Raymond Speth.

Built with Sphinx using a theme provided by Read the Docs.