pycontrails.models.cocip.CocipFlightParams

class pycontrails.models.cocip.CocipFlightParams(copy_source=True, interpolation_method='linear', interpolation_bounds_error=False, interpolation_fill_value=nan, interpolation_localize=False, interpolation_use_indices=False, interpolation_q_method=None, verify_met=True, downselect_met=True, met_longitude_buffer=(10.0, 10.0), met_latitude_buffer=(10.0, 10.0), met_level_buffer=(40.0, 40.0), met_time_buffer=(np.timedelta64(0, 'h'), np.timedelta64(0, 'h')), process_emissions=True, dt_integration=np.timedelta64(30, 'm'), dz_m=200.0, effective_vertical_resolution=2000.0, smooth_true_airspeed=True, smooth_true_airspeed_window_length=7, smooth_true_airspeed_polyorder=1, humidity_scaling=None, preprocess_lowmem=False, compute_tau_cirrus_in_model_init='auto', filter_sac=True, filter_initially_persistent=True, persistent_buffer=None, verbose_outputs=False, compute_atr20=False, global_rf_to_atr20_factor=0.0151, initial_wake_vortex_depth=0.5, sedimentation_impact_factor=0.5, default_nvpm_ei_n=1000000000000000.0, wind_shear_enhancement_exponent=0.5, nvpm_ei_n_enhancement_factor=1.0, min_ice_particle_number_nvpm_ei_n=10000000000000.0, max_depth=1500.0, unterstrasser_ice_survival_fraction=False, radiative_heating_effects=False, contrail_contrail_overlapping=False, dz_overlap_m=500.0, radius_threshold_um=<factory>, habits=<factory>, habit_distributions=<factory>, rf_sw_enhancement_factor=1.0, rf_lw_enhancement_factor=1.0, min_altitude_m=6000.0, max_altitude_m=13000.0, max_seg_length_m=40000.0, max_age=np.timedelta64(20, 'h'), min_tau=1e-06, max_tau=10000000000.0, min_n_ice_per_m3=1000.0, max_n_ice_per_m3=1e+20, aircraft_performance=None)

Bases: CocipParams

Flight specific CoCiP parameters.

__init__(copy_source=True, interpolation_method='linear', interpolation_bounds_error=False, interpolation_fill_value=nan, interpolation_localize=False, interpolation_use_indices=False, interpolation_q_method=None, verify_met=True, downselect_met=True, met_longitude_buffer=(10.0, 10.0), met_latitude_buffer=(10.0, 10.0), met_level_buffer=(40.0, 40.0), met_time_buffer=(np.timedelta64(0, 'h'), np.timedelta64(0, 'h')), process_emissions=True, dt_integration=np.timedelta64(30, 'm'), dz_m=200.0, effective_vertical_resolution=2000.0, smooth_true_airspeed=True, smooth_true_airspeed_window_length=7, smooth_true_airspeed_polyorder=1, humidity_scaling=None, preprocess_lowmem=False, compute_tau_cirrus_in_model_init='auto', filter_sac=True, filter_initially_persistent=True, persistent_buffer=None, verbose_outputs=False, compute_atr20=False, global_rf_to_atr20_factor=0.0151, initial_wake_vortex_depth=0.5, sedimentation_impact_factor=0.5, default_nvpm_ei_n=1000000000000000.0, wind_shear_enhancement_exponent=0.5, nvpm_ei_n_enhancement_factor=1.0, min_ice_particle_number_nvpm_ei_n=10000000000000.0, max_depth=1500.0, unterstrasser_ice_survival_fraction=False, radiative_heating_effects=False, contrail_contrail_overlapping=False, dz_overlap_m=500.0, radius_threshold_um=<factory>, habits=<factory>, habit_distributions=<factory>, rf_sw_enhancement_factor=1.0, rf_lw_enhancement_factor=1.0, min_altitude_m=6000.0, max_altitude_m=13000.0, max_seg_length_m=40000.0, max_age=np.timedelta64(20, 'h'), min_tau=1e-06, max_tau=10000000000.0, min_n_ice_per_m3=1000.0, max_n_ice_per_m3=1e+20, aircraft_performance=None)

Methods

__init__([copy_source, ...])
as_dict()	Convert object to dictionary.

Attributes

aircraft_performance	Aircraft performance model
compute_atr20	Add additional metric of ATR20 and global yearly mean RF to model output.
compute_tau_cirrus_in_model_init	Compute "tau_cirrus" variable in pressure-level met data during model initialization.
contrail_contrail_overlapping	Experimental.
copy_source	Copy input source data on eval
default_nvpm_ei_n	Default nvpm_ei_n value if no data provided and emissions calculations fails.
downselect_met	Downselect input MetDataset` to region around source.
dt_integration	Apply Euler's method with a fixed step size of dt_integration.
dz_m	Difference in altitude between top and bottom layer for stratification calculations, [\(m\)].
dz_overlap_m	Experimental.
effective_vertical_resolution	Vertical resolution (m) associated to met data.
filter_initially_persistent	Filter out waypoints if they don't satisfy the initial persistent criteria Passing in a non-default value is unusual, but is included to allow for false negative calibration and model uncertainty studies.
filter_sac	Filter out waypoints if the don't satisfy the SAC criteria Note that the SAC algorithm will still be run to calculate T_critical_sac for use estimating initial ice particle number.
global_rf_to_atr20_factor	Constant factor used to convert global- and year-mean RF, [\(W m^{-2}\)], to ATR20, [\(K\)], given by [Yin et al., 2023].
humidity_scaling	Humidity scaling
initial_wake_vortex_depth	Initial wake vortex depth scaling factor.
interpolation_bounds_error	If True, points lying outside interpolation will raise an error
interpolation_fill_value	Used for outside interpolation value if interpolation_bounds_error is False
interpolation_localize	Experimental.
interpolation_method	Interpolation method.
interpolation_q_method	Experimental.
interpolation_use_indices	Experimental.
max_age	Max age of contrail evolution.
max_altitude_m	Maximum altitude domain in simulation, [\(m\)] If set to None, this check is disabled.
max_depth	Upper bound for contrail plume depth, constraining it to realistic values.
max_n_ice_per_m3	Maximum contrail ice particle number per volume of air to prevent unrealistic values.
max_seg_length_m	Maximum contrail segment length in simulation to prevent unrealistic values, [\(m\)].
max_tau	Maximum contrail optical depth to prevent unrealistic values.
met_latitude_buffer	Met latitude buffer [WGS84] for Cocip evolution.
met_level_buffer	Met level buffer [\(hPa\)] for Cocip initialization and evolution.
met_longitude_buffer	Met longitude [WGS84] buffer for Cocip evolution.
met_time_buffer	Met time buffer for input to Flight.downselect_met() Only applies when downselect_met is True.
min_altitude_m	Minimum altitude domain in simulation, [\(m\)] If set to None, this check is disabled.
min_ice_particle_number_nvpm_ei_n	Lower bound for nvpm_ei_n to account for ambient aerosol particles for newer engines, [\(kg^{-1}\)]
min_n_ice_per_m3	Minimum contrail ice particle number per volume of air.
min_tau	Minimum contrail optical depth.
nvpm_ei_n_enhancement_factor	Multiply flight black carbon number by enhancement factor.
persistent_buffer	Continue evolving contrail waypoints persistent_buffer beyond end of contrail life.
preprocess_lowmem	Experimental.
process_emissions	Determines whether Cocip.process_emissions() runs on model Cocip.eval() Set to False when input Flight includes emissions data.
radiative_heating_effects	Experimental.
rf_lw_enhancement_factor	Scale longwave radiative forcing.
rf_sw_enhancement_factor	Scale shortwave radiative forcing.
sedimentation_impact_factor	Sedimentation impact factor.
smooth_true_airspeed	Smoothing parameters for true airspeed.
smooth_true_airspeed_polyorder
smooth_true_airspeed_window_length
unterstrasser_ice_survival_fraction	Experimental.
verbose_outputs	Add additional values to the flight and contrail that are not explicitly necessary for calculation.
verify_met	Call _verify_met() on model instantiation.
wind_shear_enhancement_exponent	Parameter denoted by \(n\) in eq.
radius_threshold_um	Radius threshold for regime bins, [\(\mu m\)] This is the row index label for habit_distributions.
habits	Particle habit (shape) types.
habit_distributions	Mix of ice particle habits in each radius regime.

aircraft_performance = None

Aircraft performance model