few: Fast EMRI Waveforms

User guide:

  • Overall Waveform Models
    • Generic Waveform Generator
      • GenerateEMRIWaveform
        • GenerateEMRIWaveform.waveform_generator
        • GenerateEMRIWaveform.frame
        • GenerateEMRIWaveform.return_list
        • GenerateEMRIWaveform.flip_output
        • GenerateEMRIWaveform.args_remove
        • GenerateEMRIWaveform.phases_needed
        • GenerateEMRIWaveform.__call__()
    • Prebuilt Waveform Models
      • Fast Kerr Eccentric Equatorial Flux-based Waveform
        • FastKerrEccentricEquatorialFlux
      • Fast Schwarzschild Eccentric Flux-based Waveform
        • FastSchwarzschildEccentricFlux
        • FastSchwarzschildEccentricFluxBicubic
      • Slow Schwarzschild Eccentric Flux-based Waveform
        • SlowSchwarzschildEccentricFlux
      • Generic Kerr AAK with 5PN Trajectory
        • Pn5AAKWaveform
    • Base Classes
      • Spherical Harmonic (Flux-based) Waveforms
        • SphericalHarmonic
        • SphericalHarmonicWaveformBase
      • Schwarzschild Eccentric
        • SchwarzschildEccentric
      • Kerr Eccentric Equatorial
        • KerrEccentricEquatorial
      • 5PN + AAK Waveform for Generic Kerr
        • Pn5AAK
        • AAKWaveformBase
      • GPU Module Base Class
        • ParallelModuleBase
  • Trajectory Package
    • TrajectoryBase
      • TrajectoryBase.get_inspiral()
      • TrajectoryBase.__call__()
      • TrajectoryBase.citation()
      • TrajectoryBase.module_references()
    • Generic Inspiral Generator
      • EMRIInspiral
        • EMRIInspiral.inspiral_generator
        • EMRIInspiral.specific_kwarg_keys
        • EMRIInspiral.module_references()
        • EMRIInspiral.npoints
        • EMRIInspiral.tolerance
        • EMRIInspiral.dense_stepping
        • EMRIInspiral.integrate_backwards
        • EMRIInspiral.get_inspiral()
        • EMRIInspiral.__call__()
        • EMRIInspiral.citation()
        • EMRIInspiral.get_rhs_ode()
      • get_0PA_frequencies()
    • ODE Integrators
      • Integrate
        • Integrate.nparams
        • Integrate.num_add_args
        • Integrate.convert_Y
        • Integrate.background
        • Integrate.equatorial
        • Integrate.circular
        • Integrate.integrate_constants_of_motion
        • Integrate.separatrix_buffer_dist
        • Integrate.distance_to_outer_boundary()
        • Integrate.take_step()
        • Integrate.log_failed_step()
        • Integrate.tune_initial_step_size()
        • Integrate.integrate()
        • Integrate.action_function()
        • Integrate.initialize_integrator()
        • Integrate.tolerance
        • Integrate.dense_stepping
        • Integrate.npoints
        • Integrate.trajectory
        • Integrate.integrator_t_cache
        • Integrate.integrator_spline_coeff
        • Integrate.save_point()
        • Integrate.eval_integrator_spline()
        • Integrate.eval_integrator_derivative_spline()
        • Integrate.run_inspiral()
        • Integrate.stop_integrate_check()
        • Integrate.inner_func_forward()
        • Integrate.inner_func_backward()
        • Integrate.finishing_function()
        • Integrate.get_pex()
      • APEXIntegrate
        • APEXIntegrate.get_pex()
        • APEXIntegrate.action_function()
        • APEXIntegrate.background
        • APEXIntegrate.circular
        • APEXIntegrate.convert_Y
        • APEXIntegrate.dense_stepping
        • APEXIntegrate.distance_to_outer_boundary()
        • APEXIntegrate.equatorial
        • APEXIntegrate.eval_integrator_derivative_spline()
        • APEXIntegrate.eval_integrator_spline()
        • APEXIntegrate.finishing_function()
        • APEXIntegrate.initialize_integrator()
        • APEXIntegrate.inner_func_backward()
        • APEXIntegrate.inner_func_forward()
        • APEXIntegrate.integrate()
        • APEXIntegrate.integrate_constants_of_motion
        • APEXIntegrate.integrator_spline_coeff
        • APEXIntegrate.integrator_t_cache
        • APEXIntegrate.log_failed_step()
        • APEXIntegrate.nparams
        • APEXIntegrate.npoints
        • APEXIntegrate.num_add_args
        • APEXIntegrate.run_inspiral()
        • APEXIntegrate.save_point()
        • APEXIntegrate.separatrix_buffer_dist
        • APEXIntegrate.stop_integrate_check()
        • APEXIntegrate.take_step()
        • APEXIntegrate.tolerance
        • APEXIntegrate.trajectory
        • APEXIntegrate.tune_initial_step_size()
      • AELQIntegrate
        • AELQIntegrate.action_function()
        • AELQIntegrate.background
        • AELQIntegrate.circular
        • AELQIntegrate.convert_Y
        • AELQIntegrate.dense_stepping
        • AELQIntegrate.distance_to_outer_boundary()
        • AELQIntegrate.equatorial
        • AELQIntegrate.eval_integrator_derivative_spline()
        • AELQIntegrate.eval_integrator_spline()
        • AELQIntegrate.finishing_function()
        • AELQIntegrate.get_pex()
        • AELQIntegrate.initialize_integrator()
        • AELQIntegrate.inner_func_backward()
        • AELQIntegrate.inner_func_forward()
        • AELQIntegrate.integrate()
        • AELQIntegrate.integrate_constants_of_motion
        • AELQIntegrate.integrator_spline_coeff
        • AELQIntegrate.integrator_t_cache
        • AELQIntegrate.log_failed_step()
        • AELQIntegrate.nparams
        • AELQIntegrate.npoints
        • AELQIntegrate.num_add_args
        • AELQIntegrate.run_inspiral()
        • AELQIntegrate.save_point()
        • AELQIntegrate.separatrix_buffer_dist
        • AELQIntegrate.stop_integrate_check()
        • AELQIntegrate.take_step()
        • AELQIntegrate.tolerance
        • AELQIntegrate.trajectory
        • AELQIntegrate.tune_initial_step_size()
    • ODE Classes
      • ODEBase
        • ODEBase.use_ELQ
        • ODEBase.num_add_args
        • ODEBase.integrate_backwards
        • ODEBase.convert_Y
        • ODEBase.equatorial
        • ODEBase.circular
        • ODEBase.supports_ELQ
        • ODEBase.background
        • ODEBase.separatrix_buffer_dist
        • ODEBase.nparams
        • ODEBase.flux_output_convention
        • ODEBase.evaluate_rhs()
        • ODEBase.modify_rhs_before_Jacobian()
        • ODEBase.min_p()
        • ODEBase.max_p()
        • ODEBase.min_e()
        • ODEBase.max_e()
        • ODEBase.modify_rhs()
        • ODEBase.interpolate_flux_grids()
        • ODEBase.distance_to_outer_boundary()
        • ODEBase.get_pex()
        • ODEBase.cache_values_and_check_bounds()
        • ODEBase.__call__()
      • SchwarzEccFlux
        • SchwarzEccFlux.supports_ELQ
        • SchwarzEccFlux.min_p()
        • SchwarzEccFlux.max_p()
        • SchwarzEccFlux.max_e()
        • SchwarzEccFlux.distance_to_outer_boundary()
        • SchwarzEccFlux.interpolate_flux_grids()
        • SchwarzEccFlux.evaluate_rhs()
      • KerrEccEqFlux
        • KerrEccEqFlux.supports_ELQ
        • KerrEccEqFlux.min_p()
        • KerrEccEqFlux.max_p()
        • KerrEccEqFlux.min_e()
        • KerrEccEqFlux.max_e()
        • KerrEccEqFlux.distance_to_outer_boundary()
        • KerrEccEqFlux.interpolate_flux_grids()
        • KerrEccEqFlux.evaluate_rhs()
      • KerrEccEqFluxLegacy
        • KerrEccEqFluxLegacy.supports_ELQ
        • KerrEccEqFluxLegacy.flux_output_convention
        • KerrEccEqFluxLegacy.interpolate_flux_grids()
        • KerrEccEqFluxLegacy.evaluate_rhs()
      • PN5
        • PN5.supports_ELQ
        • PN5.max_p()
        • PN5.min_p()
        • PN5.max_e()
        • PN5.evaluate_rhs()
  • Amplitude Package
    • AmplitudeBase
      • AmplitudeBase.get_amplitudes()
      • AmplitudeBase.__call__()
      • AmplitudeBase.citation()
      • AmplitudeBase.module_references()
    • ROMAN Network
      • RomanAmplitude
        • RomanAmplitude.attributes_RomanAmplitude()
        • RomanAmplitude.num_teuk_modes
        • RomanAmplitude.module_references()
        • RomanAmplitude.supported_backends()
        • RomanAmplitude.get_amplitudes()
        • RomanAmplitude.CPU_ONLY()
        • RomanAmplitude.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • RomanAmplitude.GPU_ONLY()
        • RomanAmplitude.GPU_RECOMMENDED()
        • RomanAmplitude.__call__()
        • RomanAmplitude.adapt_backend_kwargs()
        • RomanAmplitude.backend
        • RomanAmplitude.backend_name
        • RomanAmplitude.background
        • RomanAmplitude.build_with_same_backend()
        • RomanAmplitude.citation()
        • RomanAmplitude.descriptor
        • RomanAmplitude.frame
        • RomanAmplitude.needs_Y
        • RomanAmplitude.sanity_check_init()
        • RomanAmplitude.sanity_check_traj()
        • RomanAmplitude.sanity_check_viewing_angles()
        • RomanAmplitude.xp
        • RomanAmplitude.ndim
        • RomanAmplitude.lmax
        • RomanAmplitude.nmax
        • RomanAmplitude.num_modes
        • RomanAmplitude.m0sort
        • RomanAmplitude.l_arr_no_mask
        • RomanAmplitude.m_arr_no_mask
        • RomanAmplitude.n_arr_no_mask
        • RomanAmplitude.lmn_indices
        • RomanAmplitude.m0mask
        • RomanAmplitude.num_m_zero_up
        • RomanAmplitude.num_m0
        • RomanAmplitude.num_m_1_up
        • RomanAmplitude.l_arr
        • RomanAmplitude.m_arr
        • RomanAmplitude.n_arr
        • RomanAmplitude.m_zero_up_mask
        • RomanAmplitude.unique_l
        • RomanAmplitude.unique_m
        • RomanAmplitude.num_unique_lm
        • RomanAmplitude.index_map
        • RomanAmplitude.special_index_map
        • RomanAmplitude.index_map_arr
        • RomanAmplitude.special_index_map_arr
    • 2D Cubic Spline Interpolation
      • AmpInterp2D
        • AmpInterp2D.l_arr
        • AmpInterp2D.m_arr
        • AmpInterp2D.n_arr
        • AmpInterp2D.num_teuk_modes
        • AmpInterp2D.knots
        • AmpInterp2D.coeff
        • AmpInterp2D.len_indiv_c
        • AmpInterp2D.interp2D
        • AmpInterp2D.module_references()
        • AmpInterp2D.supported_backends()
        • AmpInterp2D.__call__()
        • AmpInterp2D.CPU_ONLY()
        • AmpInterp2D.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • AmpInterp2D.GPU_ONLY()
        • AmpInterp2D.GPU_RECOMMENDED()
        • AmpInterp2D.adapt_backend_kwargs()
        • AmpInterp2D.backend
        • AmpInterp2D.backend_name
        • AmpInterp2D.build_with_same_backend()
        • AmpInterp2D.citation()
        • AmpInterp2D.get_amplitudes()
        • AmpInterp2D.xp
      • AmpInterpKerrEccEq
        • AmpInterpKerrEccEq.get_amplitudes()
        • AmpInterpKerrEccEq.CPU_ONLY()
        • AmpInterpKerrEccEq.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • AmpInterpKerrEccEq.GPU_ONLY()
        • AmpInterpKerrEccEq.GPU_RECOMMENDED()
        • AmpInterpKerrEccEq.__call__()
        • AmpInterpKerrEccEq.adapt_backend_kwargs()
        • AmpInterpKerrEccEq.backend
        • AmpInterpKerrEccEq.backend_name
        • AmpInterpKerrEccEq.background
        • AmpInterpKerrEccEq.build_with_same_backend()
        • AmpInterpKerrEccEq.citation()
        • AmpInterpKerrEccEq.descriptor
        • AmpInterpKerrEccEq.frame
        • AmpInterpKerrEccEq.module_references()
        • AmpInterpKerrEccEq.needs_Y
        • AmpInterpKerrEccEq.sanity_check_init()
        • AmpInterpKerrEccEq.sanity_check_traj()
        • AmpInterpKerrEccEq.sanity_check_viewing_angles()
        • AmpInterpKerrEccEq.supported_backends()
        • AmpInterpKerrEccEq.xp
        • AmpInterpKerrEccEq.ndim
        • AmpInterpKerrEccEq.lmax
        • AmpInterpKerrEccEq.nmax
        • AmpInterpKerrEccEq.num_modes
        • AmpInterpKerrEccEq.num_teuk_modes
        • AmpInterpKerrEccEq.m0sort
        • AmpInterpKerrEccEq.l_arr_no_mask
        • AmpInterpKerrEccEq.m_arr_no_mask
        • AmpInterpKerrEccEq.n_arr_no_mask
        • AmpInterpKerrEccEq.lmn_indices
        • AmpInterpKerrEccEq.m0mask
        • AmpInterpKerrEccEq.num_m_zero_up
        • AmpInterpKerrEccEq.num_m0
        • AmpInterpKerrEccEq.num_m_1_up
        • AmpInterpKerrEccEq.l_arr
        • AmpInterpKerrEccEq.m_arr
        • AmpInterpKerrEccEq.n_arr
        • AmpInterpKerrEccEq.m_zero_up_mask
        • AmpInterpKerrEccEq.unique_l
        • AmpInterpKerrEccEq.unique_m
        • AmpInterpKerrEccEq.num_unique_lm
        • AmpInterpKerrEccEq.index_map
        • AmpInterpKerrEccEq.special_index_map
        • AmpInterpKerrEccEq.index_map_arr
        • AmpInterpKerrEccEq.special_index_map_arr
      • AmpInterpSchwarzEcc
        • AmpInterpSchwarzEcc.CPU_ONLY()
        • AmpInterpSchwarzEcc.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • AmpInterpSchwarzEcc.GPU_ONLY()
        • AmpInterpSchwarzEcc.GPU_RECOMMENDED()
        • AmpInterpSchwarzEcc.__call__()
        • AmpInterpSchwarzEcc.adapt_backend_kwargs()
        • AmpInterpSchwarzEcc.backend
        • AmpInterpSchwarzEcc.backend_name
        • AmpInterpSchwarzEcc.background
        • AmpInterpSchwarzEcc.build_with_same_backend()
        • AmpInterpSchwarzEcc.citation()
        • AmpInterpSchwarzEcc.descriptor
        • AmpInterpSchwarzEcc.frame
        • AmpInterpSchwarzEcc.module_references()
        • AmpInterpSchwarzEcc.needs_Y
        • AmpInterpSchwarzEcc.sanity_check_init()
        • AmpInterpSchwarzEcc.sanity_check_traj()
        • AmpInterpSchwarzEcc.sanity_check_viewing_angles()
        • AmpInterpSchwarzEcc.supported_backends()
        • AmpInterpSchwarzEcc.xp
        • AmpInterpSchwarzEcc.ndim
        • AmpInterpSchwarzEcc.lmax
        • AmpInterpSchwarzEcc.nmax
        • AmpInterpSchwarzEcc.num_modes
        • AmpInterpSchwarzEcc.m0sort
        • AmpInterpSchwarzEcc.l_arr_no_mask
        • AmpInterpSchwarzEcc.m_arr_no_mask
        • AmpInterpSchwarzEcc.n_arr_no_mask
        • AmpInterpSchwarzEcc.lmn_indices
        • AmpInterpSchwarzEcc.m0mask
        • AmpInterpSchwarzEcc.num_m_zero_up
        • AmpInterpSchwarzEcc.num_m0
        • AmpInterpSchwarzEcc.num_m_1_up
        • AmpInterpSchwarzEcc.l_arr
        • AmpInterpSchwarzEcc.m_arr
        • AmpInterpSchwarzEcc.n_arr
        • AmpInterpSchwarzEcc.m_zero_up_mask
        • AmpInterpSchwarzEcc.unique_l
        • AmpInterpSchwarzEcc.unique_m
        • AmpInterpSchwarzEcc.num_unique_lm
        • AmpInterpSchwarzEcc.index_map
        • AmpInterpSchwarzEcc.special_index_map
        • AmpInterpSchwarzEcc.index_map_arr
        • AmpInterpSchwarzEcc.special_index_map_arr
        • AmpInterpSchwarzEcc.filename
        • AmpInterpSchwarzEcc.tck
        • AmpInterpSchwarzEcc.num_teuk_modes
        • AmpInterpSchwarzEcc.len_indiv_c
        • AmpInterpSchwarzEcc.interp2D
        • AmpInterpSchwarzEcc.get_amplitudes()
  • Summation Package
    • SummationBase
      • SummationBase.sum()
      • SummationBase.__call__()
      • SummationBase.CPU_ONLY()
      • SummationBase.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
      • SummationBase.GPU_ONLY()
      • SummationBase.GPU_RECOMMENDED()
      • SummationBase.adapt_backend_kwargs()
      • SummationBase.backend
      • SummationBase.backend_name
      • SummationBase.build_with_same_backend()
      • SummationBase.citation()
      • SummationBase.module_references()
      • SummationBase.supported_backends()
      • SummationBase.xp
    • Interpolated Summation
      • CubicSplineInterpolant
        • CubicSplineInterpolant.degree
        • CubicSplineInterpolant.ninterps
        • CubicSplineInterpolant.length
        • CubicSplineInterpolant.reshape_shape
        • CubicSplineInterpolant.interpolate_arrays
        • CubicSplineInterpolant.supported_backends()
        • CubicSplineInterpolant.y
        • CubicSplineInterpolant.c1
        • CubicSplineInterpolant.c2
        • CubicSplineInterpolant.c3
        • CubicSplineInterpolant.CPU_ONLY()
        • CubicSplineInterpolant.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • CubicSplineInterpolant.GPU_ONLY()
        • CubicSplineInterpolant.GPU_RECOMMENDED()
        • CubicSplineInterpolant.adapt_backend_kwargs()
        • CubicSplineInterpolant.backend
        • CubicSplineInterpolant.backend_name
        • CubicSplineInterpolant.build_with_same_backend()
        • CubicSplineInterpolant.citation()
        • CubicSplineInterpolant.module_references()
        • CubicSplineInterpolant.xp
        • CubicSplineInterpolant.__call__()
      • InterpolatedModeSum
        • InterpolatedModeSum.CPU_ONLY()
        • InterpolatedModeSum.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • InterpolatedModeSum.GPU_ONLY()
        • InterpolatedModeSum.GPU_RECOMMENDED()
        • InterpolatedModeSum.__call__()
        • InterpolatedModeSum.adapt_backend_kwargs()
        • InterpolatedModeSum.backend
        • InterpolatedModeSum.backend_name
        • InterpolatedModeSum.build_with_same_backend()
        • InterpolatedModeSum.citation()
        • InterpolatedModeSum.module_references()
        • InterpolatedModeSum.xp
        • InterpolatedModeSum.get_waveform
        • InterpolatedModeSum.supported_backends()
        • InterpolatedModeSum.sum()
      • FDInterpolatedModeSum
        • FDInterpolatedModeSum.get_waveform_fd
        • FDInterpolatedModeSum.supported_backends()
        • FDInterpolatedModeSum.module_references()
        • FDInterpolatedModeSum.sum()
        • FDInterpolatedModeSum.CPU_ONLY()
        • FDInterpolatedModeSum.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • FDInterpolatedModeSum.GPU_ONLY()
        • FDInterpolatedModeSum.GPU_RECOMMENDED()
        • FDInterpolatedModeSum.__call__()
        • FDInterpolatedModeSum.adapt_backend_kwargs()
        • FDInterpolatedModeSum.backend
        • FDInterpolatedModeSum.backend_name
        • FDInterpolatedModeSum.background
        • FDInterpolatedModeSum.build_with_same_backend()
        • FDInterpolatedModeSum.citation()
        • FDInterpolatedModeSum.descriptor
        • FDInterpolatedModeSum.frame
        • FDInterpolatedModeSum.needs_Y
        • FDInterpolatedModeSum.sanity_check_init()
        • FDInterpolatedModeSum.sanity_check_traj()
        • FDInterpolatedModeSum.sanity_check_viewing_angles()
        • FDInterpolatedModeSum.xp
        • FDInterpolatedModeSum.ndim
        • FDInterpolatedModeSum.lmax
        • FDInterpolatedModeSum.nmax
        • FDInterpolatedModeSum.num_modes
        • FDInterpolatedModeSum.num_teuk_modes
        • FDInterpolatedModeSum.m0sort
        • FDInterpolatedModeSum.l_arr_no_mask
        • FDInterpolatedModeSum.m_arr_no_mask
        • FDInterpolatedModeSum.n_arr_no_mask
        • FDInterpolatedModeSum.lmn_indices
        • FDInterpolatedModeSum.m0mask
        • FDInterpolatedModeSum.num_m_zero_up
        • FDInterpolatedModeSum.num_m0
        • FDInterpolatedModeSum.num_m_1_up
        • FDInterpolatedModeSum.l_arr
        • FDInterpolatedModeSum.m_arr
        • FDInterpolatedModeSum.n_arr
        • FDInterpolatedModeSum.m_zero_up_mask
        • FDInterpolatedModeSum.unique_l
        • FDInterpolatedModeSum.unique_m
        • FDInterpolatedModeSum.num_unique_lm
        • FDInterpolatedModeSum.index_map
        • FDInterpolatedModeSum.special_index_map
        • FDInterpolatedModeSum.index_map_arr
        • FDInterpolatedModeSum.special_index_map_arr
    • Direct Summation
      • DirectModeSum
        • DirectModeSum.supported_backends()
        • DirectModeSum.sum()
        • DirectModeSum.CPU_ONLY()
        • DirectModeSum.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • DirectModeSum.GPU_ONLY()
        • DirectModeSum.GPU_RECOMMENDED()
        • DirectModeSum.__call__()
        • DirectModeSum.adapt_backend_kwargs()
        • DirectModeSum.backend
        • DirectModeSum.backend_name
        • DirectModeSum.build_with_same_backend()
        • DirectModeSum.citation()
        • DirectModeSum.module_references()
        • DirectModeSum.xp
    • AAK Summation / Waveform Generator
      • AAKSummation
        • AAKSummation.waveform_generator
        • AAKSummation.supported_backends()
        • AAKSummation.sum()
        • AAKSummation.CPU_ONLY()
        • AAKSummation.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • AAKSummation.GPU_ONLY()
        • AAKSummation.GPU_RECOMMENDED()
        • AAKSummation.__call__()
        • AAKSummation.adapt_backend_kwargs()
        • AAKSummation.backend
        • AAKSummation.backend_name
        • AAKSummation.background
        • AAKSummation.build_with_same_backend()
        • AAKSummation.citation()
        • AAKSummation.descriptor
        • AAKSummation.frame
        • AAKSummation.module_references()
        • AAKSummation.needs_Y
        • AAKSummation.sanity_check_angles()
        • AAKSummation.sanity_check_init()
        • AAKSummation.sanity_check_traj()
        • AAKSummation.xp
  • Configuration options
    • Tunable utilities
      • Log level
      • Backends management
      • File manager
        • file_storage_path
        • file_download_path
        • file_extra_paths
        • file_registry_path
        • file_integrity_check
        • file_allow_download
    • Summary of configuration options
    • Configuration setter
  • Utilities
    • Mode Filtering
      • ModeSelector
        • ModeSelector.m0mask
        • ModeSelector.num_m_zero_up
        • ModeSelector.num_m_1_up
        • ModeSelector.num_m0
        • ModeSelector.l_arr
        • ModeSelector.m_arr
        • ModeSelector.n_arr
        • ModeSelector.sensitivity_fn
        • ModeSelector.include_minus_mkn
        • ModeSelector.negative_m_flag
        • ModeSelector.mode_selection_threshold
        • ModeSelector.supported_backends()
        • ModeSelector.is_predictive
        • ModeSelector.__call__()
        • ModeSelector.CPU_ONLY()
        • ModeSelector.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • ModeSelector.GPU_ONLY()
        • ModeSelector.GPU_RECOMMENDED()
        • ModeSelector.adapt_backend_kwargs()
        • ModeSelector.backend
        • ModeSelector.backend_name
        • ModeSelector.build_with_same_backend()
        • ModeSelector.citation()
        • ModeSelector.module_references()
        • ModeSelector.xp
      • NeuralModeSelector
        • NeuralModeSelector.CPU_ONLY()
        • NeuralModeSelector.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • NeuralModeSelector.GPU_ONLY()
        • NeuralModeSelector.GPU_RECOMMENDED()
        • NeuralModeSelector.adapt_backend_kwargs()
        • NeuralModeSelector.backend
        • NeuralModeSelector.backend_name
        • NeuralModeSelector.build_with_same_backend()
        • NeuralModeSelector.citation()
        • NeuralModeSelector.module_references()
        • NeuralModeSelector.xp
        • NeuralModeSelector.supported_backends()
        • NeuralModeSelector.is_predictive
        • NeuralModeSelector.__call__()
    • (-2) Spin-Weighted Spherical Harmonics
      • GetYlms
        • GetYlms.supported_backends()
        • GetYlms.__call__()
        • GetYlms.CPU_ONLY()
        • GetYlms.CPU_RECOMMENDED_WITH_GPU_SUPPORT()
        • GetYlms.GPU_ONLY()
        • GetYlms.GPU_RECOMMENDED()
        • GetYlms.adapt_backend_kwargs()
        • GetYlms.backend
        • GetYlms.backend_name
        • GetYlms.build_with_same_backend()
        • GetYlms.citation()
        • GetYlms.module_references()
        • GetYlms.xp
    • Frequency Domain Utilities
      • get_convolution()
      • get_fft_td_windowed()
      • get_fd_windowed()
      • GetFDWaveformFromFD
        • GetFDWaveformFromFD.__call__()
      • GetFDWaveformFromTD
        • GetFDWaveformFromTD.__call__()
    • Analysis and Other Tools
      • get_overlap()
      • get_mismatch()
      • get_at_t()
      • get_p_at_t()
      • get_m2_at_t()
      • wrapper()
      • pointer_adjust()
    • Elliptic integrals (Legendre and Carlson symmetric forms)
      • RF()
      • RC()
      • RJ()
      • RD()
      • EllipK()
      • EllipE()
      • EllipPi()
    • PN Parameter Mapping Utilities
      • Y_to_xI()
      • xI_to_Y()
  • Installation guide
    • On Mac OS with Apple Silicon CPU (M1 to M4)
      • Preliminary steps
      • Perform a from-source install
        • With automatic LAPACK(E) fetching
        • With conda-installed LAPACK
      • Perform a package install
      • Configure file storage
      • Run tests
    • On Windows
      • Preliminary steps
      • Perform a from-source install
      • Run tests
    • On CNES cluster, with GPU and jupyter hub supports
      • Preliminary steps
      • Perform a from-source install
      • Perform a package install
      • Test FEW is working correctly
      • Make the conda environment available as a Jupyter Hub kernel
    • On the CC-IN2P3 cluster with GPU support
      • Preliminary steps
      • Perform a from-source install
      • Perform a package install
      • Configure file storage
      • Run tests

Tutorial:

  • Tutorial: Fast self-forced trajectories
    • ODE classes
      • Parameter conventions
      • Stock trajectory models
      • Obtaining the right-hand side of the trajectory ODE
      • Checking the properties of an ODE system
        • Checking the model domain of validity
    • Trajectory evaluation
      • The EMRIInspiral class
      • Trajectory stopping conditions
      • Output for a requested time duration
      • Output on a requested time grid
      • Return trajectory in dimensionless time coordinates
      • Integrating trajectories with a fixed time-step
      • Evolving trajectories backwards in time
      • Setting the integrator error tolerance
      • Integrating trajectories in \((E, L, Q)\) coordinates
    • Trajectory-related utilities
      • Get \(p_0\) based on desired duration of trajectory
      • Get \(m_2\) based on desired duration of trajectory
    • User-defined trajectory models
      • Defining a new trajectory model
      • Modifying an existing trajectory model
      • Passing additional arguments to a modified trajectory model
  • Tutorial: Rapid Teukolsky mode amplitudes
    • Spline interpolation
    • ROMAN amplitude generation
  • EMRI Waveforms in Time and Frequency Domain
    • Comparing Time and Frequency domain waveforms
    • FD utilities and windowing
  • Signal to noise ratio as a function of eccentricity and spin
    • Speed test as a function of the parameter space
    • Mass invariance
    • Downsampled FD Waveforms
  • Mode Selection
    • Mode selection by power contribution
    • Mode selection by noise-weighted power contribution
    • Compare the two waves with and without noise-weighting
    • Specific mode selection
    • Turn off \((-m, -k, -n)\) modes
  • Mode Summation
    • Interpolated summation
    • Direct summation
  • Parallelized Cubic Spline Interpolation
  • Spin-weighted spherical harmonics
  • Utility Functions
    • Fundamental Frequencies
    • Separatrix in Generic Kerr
    • Converting between the integrals of motion \((E, L, Q)\) and the orbital elements \((p, e, x)\)
    • Convert between \(x_I\) and \(Y\)

Developer guide:

  • Development Environment
    • Installation steps
      • Clone the repository
      • Create a dedicated virtualenv
      • Install the project in standard editable mode
      • Install the project with backend recompilation (rebuild editable mode)
    • pre-commit: apply common guidelines to your code
    • Standard development environment using devcontainers
  • Adding features
    • Add a new module to CPU and CUDA backends
    • Add a Citable class
    • Implement access to a file
      • Declare a new downloadable file
      • Obtain path to an output file
    • Add a configuration option
    • Adding log messages
  • Packaging
    • Default build process
    • Building core and plugin packages
      • Common steps
      • Building the core package
      • Building the GPU plugin packages
    • Understanding the CMake compilation mechanism
  • Write documentation
    • Build documentation
    • Test the documentation
      • Tutorials
      • Code examples
    • Add a tutorial
  • API Reference
    • Citations
      • HyphenUnderscoreAliasModel
        • HyphenUnderscoreAliasModel.model_config
      • Author
        • Author.model_config
      • Publisher
        • Publisher.model_config
      • Identifier
        • Identifier.model_config
      • ReferenceABC
        • ReferenceABC.to_bibtex()
        • ReferenceABC.model_config
      • ArxivIdentifier
        • ArxivIdentifier.model_config
      • ArticleReference
        • ArticleReference.arxiv_preprint
        • ArticleReference.to_bibtex()
        • ArticleReference.model_config
      • SoftwareReference
        • SoftwareReference.doi
        • SoftwareReference.to_bibtex()
        • SoftwareReference.model_config
      • REFERENCE
      • build_citation_registry()
      • Citable
        • Citable.citation()
        • Citable.module_references()
    • File manager
      • FileManager
        • FileManager.storage_dir
        • FileManager.download_dir
        • FileManager.options
        • FileManager.registry
        • FileManager.build_local_cache()
        • FileManager.get_tags()
        • FileManager.try_get_local_file()
        • FileManager.get_file()
        • FileManager.try_get_file()
        • FileManager.prefetch_files_by_list()
        • FileManager.prefetch_files_by_tag()
        • FileManager.prefetch_all_files()
        • FileManager.open()
      • FileRegistry
        • FileRegistry.get_repository()
        • FileRegistry.get_file()
        • FileRegistry.get_files_by_tag()
        • FileRegistry.get_tags()
        • FileRegistry.model_config
    • Configuration
      • ConfigSource
        • ConfigSource.DEFAULT
        • ConfigSource.CFGFILE
        • ConfigSource.ENVVAR
        • ConfigSource.CLIOPT
        • ConfigSource.SETTER
      • ConfigEntry
        • ConfigEntry.label
        • ConfigEntry.description
        • ConfigEntry.type
        • ConfigEntry.default
        • ConfigEntry.cfg_entry
        • ConfigEntry.env_var
        • ConfigEntry.cli_flags
        • ConfigEntry.cli_kwargs
        • ConfigEntry.convert
        • ConfigEntry.validate()
        • ConfigEntry.overwrite()
      • ConfigItem
      • ConfigConsumer
        • ConfigConsumer.config_entries()
        • ConfigConsumer.get_extras()
      • userstr_to_bool()
      • userinput_to_pathlist()
      • userinput_to_strlist()
      • InitialConfigConsumer
        • InitialConfigConsumer.config_entries()
        • InitialConfigConsumer.get_extras()
      • Configuration
        • Configuration.get_extras()
        • Configuration.config_entries()
        • Configuration.build_cli_parent_parsers()
      • detect_cfg_file()
    • Global state
      • ConfigurationSetter
        • ConfigurationSetter.enable_backends()
        • ConfigurationSetter.set_log_level()
        • ConfigurationSetter.set_storage_path()
        • ConfigurationSetter.set_log_format()
        • ConfigurationSetter.set_file_registry_path()
        • ConfigurationSetter.set_file_download_path()
        • ConfigurationSetter.enable_file_download()
        • ConfigurationSetter.disable_file_download()
        • ConfigurationSetter.set_file_integrity_check()
        • ConfigurationSetter.disable_file_tags()
        • ConfigurationSetter.add_file_extra_paths()
        • ConfigurationSetter.get_args()
        • ConfigurationSetter.finalize()
      • get_logger()
      • get_file_manager()
      • get_config()
      • get_config_setter()
      • get_backend()
      • get_first_backend()
      • has_backend()
      • initialize()

General Information:

  • FastEMRIWaveforms Publications
  • Package TODOs
  • Change Log
few: Fast EMRI Waveforms
  • Search

© Copyright 2020, Michael Katz, Alvin Chua, Niels Warburton.

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