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.emissions
        • Config.engine_file
        • 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
        • 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.pmnvol_enabled
        • EmissionsConfig.pmnvol_method
        • EmissionsConfig.pmvol_enabled
        • EmissionsConfig.pmvol_method
        • EmissionsConfig.sox_enabled
      • ClimbDescentMode
        • ClimbDescentMode.TRAJECTORY
        • ClimbDescentMode.LTO
      • EINOxMethod
        • EINOxMethod.BFFM2
        • EINOxMethod.P3T3
        • EINOxMethod.NONE
      • PMvolMethod
        • PMvolMethod.FUEL_FLOW
        • PMvolMethod.FOA3
        • PMvolMethod.NONE
      • PMnvolMethod
        • PMnvolMethod.MEEM
        • PMnvolMethod.SCOPE11
        • PMnvolMethod.FOA3
        • PMnvolMethod.NONE
    • Weather module configuration class
      • WeatherConfig
        • WeatherConfig.use_weather
        • WeatherConfig.weather_data_dir
  • Performance models
    • Performance model API
      • Loading performance models
      • Performance evaluation
      • Usage example
      • Performance model members
      • API reference
        • BasePerformanceModel
        • PerformanceModel
        • 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
      • Trajectory
        • Trajectory.__eq__
        • Trajectory.__getattr__
        • Trajectory.__hash__
        • Trajectory.__init__
        • Trajectory.__len__
        • Trajectory.__setattr__
        • Trajectory.__weakref__
        • Trajectory.add_fields
        • Trajectory.approx_eq
        • Trajectory.copy_point
        • Trajectory.nbytes
      • Field sets
        • FieldMetadata
        • FieldSet
      • 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
        • Builder.n_climb
        • Builder.n_cruise
        • Builder.n_descent
        • Builder.n_total
      • Legacy trajectory builder
        • LegacyBuilder
        • LegacyContext
        • LegacyOptions
    • Trajectory stores
      • TrajectoryStore
        • TrajectoryStore.FileMode
        • TrajectoryStore.NcFiles
        • TrajectoryStore.active_in_thread
        • TrajectoryStore.add
        • TrajectoryStore.append
        • TrajectoryStore.close
        • TrajectoryStore.create
        • TrajectoryStore.create_associated
        • TrajectoryStore.files
        • TrajectoryStore.get_flight
        • TrajectoryStore.merge
        • TrajectoryStore.nc_linked
        • TrajectoryStore.open
        • TrajectoryStore.save
        • TrajectoryStore.sync
  • Emissions module
    • Usage example
    • Computation workflow
      • compute_emissions
    • Types
      • Chemical species
        • Species
      • Emissions output
        • EmissionsOutput
        • EmissionsDict
        • ModeValues
    • Helper functions
      • get_trajectory_emissions
      • get_LTO_emissions
      • get_APU_emissions
      • get_GSE_emissions
      • EI_CO2
      • EI_H2O
      • EI_SOx
      • SOxEmissionResult
      • EI_HCCO
      • BFFM2EINOxResult
      • BFFM2_EINOx
      • NOXSpeciation
        • NOXSpeciation.hono
        • NOXSpeciation.no
        • NOXSpeciation.no2
      • PMnvol_MEEM
      • calculate_PMnvolEI_scope11
      • EI_PMvol_FOA3
      • EI_PMvol_FuelFlow
      • lifecycle_CO2
  • 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
  • Missions
    • Mission
      • Mission.aircraft_type
      • Mission.arrival
      • Mission.departure
      • Mission.destination
      • Mission.destination_position
      • Mission.flight_id
      • Mission.from_query_result
      • Mission.from_toml
      • Mission.gc_distance
      • Mission.load_factor
      • Mission.origin
      • Mission.origin_position
  • Mission database
    • Usage example
    • Reference documentation
      • Database class
        • Database
      • Queries
        • Base query class
        • Scheduled flight queries
        • Frequent flights queries
        • Count queries
      • Filters
        • Filter
    • Database schema
  • OAG flight data
    • Database creation
      • Input record filtering
      • File sizes
  • Available parsers
  • 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
    • Airport handling
      • Airport
        • Airport.country
        • Airport.elevation
        • Airport.iata_code
        • Airport.latitude
        • Airport.longitude
        • Airport.municipality
        • Airport.name
        • Airport.position
      • 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
      • great_circle_distance
    • 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
    • Standard fuel
      • get_SLS_equivalent_fuel_flow
      • get_thrust_cat_cruise
      • 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_content
        • Fuel.sulfate_yield_nom
    • Miscellaneous utility functions
      • calculate_line_parameters
      • date_to_timestamp
      • iso_to_timestamp
    • 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
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.