pyserep

Contents

  • Installation
    • Requirements
    • Standard install
    • Optional: HDF5 matrix loading
    • Development install
    • Verify the installation
    • Matrix file formats
    • Ansys DOF numbering
    • Symmetric matrix requirement
  • Quick Start
    • Installation
    • Pipeline API (recommended)
    • Functional API
    • CLI
  • API Reference
    • pyserep.io
      • enforce_symmetry()
      • load_frf_npz()
      • load_matrices()
      • load_matrix()
      • load_metrics()
      • load_reduced_matrices()
      • save_results()
      • write_ansys_node_list()
      • write_master_dofs_csv()
      • write_master_dofs_vtk()
      • write_uff58_mode_shapes()
    • pyserep.core
      • build_rayleigh_damping()
      • build_serep_rom()
      • solve_eigenproblem()
      • verify_eigenvalues()
    • pyserep.selection
      • FrequencyBand
        • FrequencyBand.centre
        • FrequencyBand.contains()
        • FrequencyBand.expanded()
        • FrequencyBand.f_max
        • FrequencyBand.f_min
        • FrequencyBand.label
        • FrequencyBand.n_points
        • FrequencyBand.span
      • FrequencyBandSet
        • FrequencyBandSet.band_weighted_mpf()
        • FrequencyBandSet.bands
        • FrequencyBandSet.frequency_grid()
        • FrequencyBandSet.frequency_mask()
        • FrequencyBandSet.global_f_max
        • FrequencyBandSet.global_f_min
        • FrequencyBandSet.is_selective
        • FrequencyBandSet.mode_passes_ms1()
        • FrequencyBandSet.n_bands
        • FrequencyBandSet.summary()
      • compare_dof_selectors()
      • mac_filter()
      • ms1_frequency_range()
      • ms2_participation_factor()
      • ms3_spatial_amplitude()
      • ms4_conditioning_check()
      • select_dofs_eid()
      • select_dofs_kinetic()
      • select_dofs_modal_disp()
      • select_dofs_svd()
      • select_modes()
      • select_modes_pipeline()
    • pyserep.frf
      • FRFResult
        • FRFResult.freqs_hz
        • FRFResult.H_rom
        • FRFResult.H_ref
        • FRFResult.band_masks
        • FRFResult.errors
        • FRFResult.method
        • FRFResult.H_ref
        • FRFResult.H_rom
        • FRFResult.band_masks
        • FRFResult.errors
        • FRFResult.freqs_hz
        • FRFResult.method
        • FRFResult.summary()
      • compute_frf_direct()
      • compute_frf_direct_fullmodel()
      • compute_frf_modal()
      • compute_frf_modal_reference()
      • compute_frf_pair_direct()
    • pyserep.analysis
      • ConvergencePoint
        • ConvergencePoint.kappa
        • ConvergencePoint.max_freq_err_pct
        • ConvergencePoint.max_frf_err_pct
        • ConvergencePoint.n_dofs
        • ConvergencePoint.n_modes
        • ConvergencePoint.param_value
        • ConvergencePoint.rms_frf_err_pct
      • ConvergenceStudy
        • ConvergenceStudy.param_label
        • ConvergenceStudy.param_name
        • ConvergenceStudy.plot()
        • ConvergenceStudy.points
        • ConvergenceStudy.table()
      • PerformanceMetrics
        • PerformanceMetrics.dof_reduction_pct
        • PerformanceMetrics.frf_flops_ref
        • PerformanceMetrics.frf_flops_rom
        • PerformanceMetrics.frf_method
        • PerformanceMetrics.frf_speedup
        • PerformanceMetrics.kappa
        • PerformanceMetrics.mode_retention_pct
        • PerformanceMetrics.n_bands
        • PerformanceMetrics.n_freq_points
        • PerformanceMetrics.n_full_dofs
        • PerformanceMetrics.n_master_dofs
        • PerformanceMetrics.n_selected_modes
        • PerformanceMetrics.summary()
        • PerformanceMetrics.t_dof_select_s
        • PerformanceMetrics.t_eigensolver_s
        • PerformanceMetrics.t_frf_s
        • PerformanceMetrics.t_mode_select_s
        • PerformanceMetrics.t_rom_build_s
        • PerformanceMetrics.t_total_s
      • ValidationReport
        • ValidationReport.eigenvalue_errors_pct
        • ValidationReport.expansion_error
        • ValidationReport.ka_condition_number
        • ValidationReport.ka_positive_definite
        • ValidationReport.ma_condition_number
        • ValidationReport.ma_positive_definite
        • ValidationReport.mac_values
        • ValidationReport.mass_ortho_error
        • ValidationReport.max_eigenvalue_error_pct
        • ValidationReport.mean_eigenvalue_error_pct
        • ValidationReport.mean_mac
        • ValidationReport.min_mac
        • ValidationReport.passed()
        • ValidationReport.stiff_ortho_error
        • ValidationReport.summary()
      • dof_count_study()
      • eigenvalue_error()
      • eigenvalue_sensitivity()
      • flop_count()
      • frf_sensitivity()
      • material_perturbation_study()
      • modal_assurance_criterion()
      • mode_count_study()
      • monte_carlo_frf()
      • orthogonality_check()
      • reduction_metrics()
      • summarise_performance()
      • validate_serep()
    • pyserep.visualization
      • plot_dof_selector_comparison()
      • plot_frf_comparison()
      • plot_frf_overlay()
      • plot_mac_matrix()
      • plot_mode_shapes()
      • plot_performance_dashboard()
    • pyserep.models
      • euler_beam()
      • model_info()
      • plate_2d()
      • random_symmetric_pd()
      • spring_chain()
    • pyserep.utils
      • Timer
      • ansys_dof()
      • apply_bcs()
      • bandwidth()
      • build_dof_map()
      • condition_number_estimate()
      • diagonal_scaling()
      • dof_to_ansys()
      • force_positive_definite()
      • is_diagonal()
      • mass_normalise()
      • matrix_stats()
      • memory_mb()
      • modal_residues()
      • modal_strain_energy()
      • rank_revealing_qr()
      • reorder_rcm()
      • safe_pinv()
      • sparse_submatrix()
      • sparsity()
      • symmetrise()
      • unscale_modes()
    • pyserep.pipeline
      • PipelineResults
        • PipelineResults.config
        • PipelineResults.freqs_hz
        • PipelineResults.phi
        • PipelineResults.selected_modes
        • PipelineResults.master_dofs
        • PipelineResults.T
        • PipelineResults.kappa
        • PipelineResults.freq_errors
        • PipelineResults.max_freq_err
        • PipelineResults.frf
        • PipelineResults.validation
        • PipelineResults.performance
        • PipelineResults.elapsed_total_s
        • PipelineResults.saved_files
        • PipelineResults.Ka
        • PipelineResults.Ma
        • PipelineResults.T
        • PipelineResults.config
        • PipelineResults.elapsed_total_s
        • PipelineResults.freq_errors
        • PipelineResults.freqs_hz
        • PipelineResults.frf
        • PipelineResults.kappa
        • PipelineResults.master_dofs
        • PipelineResults.max_freq_err
        • PipelineResults.performance
        • PipelineResults.phi
        • PipelineResults.saved_files
        • PipelineResults.selected_modes
        • PipelineResults.summary()
        • PipelineResults.validation
      • ROMConfig
        • ROMConfig.bands
        • ROMConfig.damping_type
        • ROMConfig.dof_method
        • ROMConfig.effective_bands
        • ROMConfig.eigsh_sigma
        • ROMConfig.eigsh_tol
        • ROMConfig.export_folder
        • ROMConfig.force_dofs
        • ROMConfig.freq_range
        • ROMConfig.frf_method
        • ROMConfig.global_f_max
        • ROMConfig.global_f_min
        • ROMConfig.is_selective
        • ROMConfig.ke_prescreen_frac
        • ROMConfig.mac_threshold
        • ROMConfig.mass_file
        • ROMConfig.ms1_alpha
        • ROMConfig.ms2_threshold
        • ROMConfig.ms3_threshold
        • ROMConfig.n_bands
        • ROMConfig.n_pairs
        • ROMConfig.n_points_per_band
        • ROMConfig.num_modes_eigsh
        • ROMConfig.output_dofs
        • ROMConfig.plot
        • ROMConfig.rb_hz
        • ROMConfig.save_matrices
        • ROMConfig.save_prefix
        • ROMConfig.stiffness_file
        • ROMConfig.summary()
        • ROMConfig.verbose
        • ROMConfig.zeta
      • SereпPipeline
        • SereпPipeline.run()
    • pyserep — System Equivalent Reduction Expansion Process
      • Quick start (Pipeline API)
      • Quick start (Functional API)
    • ConvergencePoint
      • ConvergencePoint.kappa
      • ConvergencePoint.max_freq_err_pct
      • ConvergencePoint.max_frf_err_pct
      • ConvergencePoint.n_dofs
      • ConvergencePoint.n_modes
      • ConvergencePoint.param_value
      • ConvergencePoint.rms_frf_err_pct
    • ConvergenceStudy
      • ConvergenceStudy.param_label
      • ConvergenceStudy.param_name
      • ConvergenceStudy.plot()
      • ConvergenceStudy.points
      • ConvergenceStudy.table()
    • FRFResult
      • FRFResult.freqs_hz
      • FRFResult.H_rom
      • FRFResult.H_ref
      • FRFResult.band_masks
      • FRFResult.errors
      • FRFResult.method
      • FRFResult.H_ref
      • FRFResult.H_rom
      • FRFResult.band_masks
      • FRFResult.errors
      • FRFResult.freqs_hz
      • FRFResult.method
      • FRFResult.summary()
    • FrequencyBand
      • FrequencyBand.centre
      • FrequencyBand.contains()
      • FrequencyBand.expanded()
      • FrequencyBand.f_max
      • FrequencyBand.f_min
      • FrequencyBand.label
      • FrequencyBand.n_points
      • FrequencyBand.span
    • FrequencyBandSet
      • FrequencyBandSet.band_weighted_mpf()
      • FrequencyBandSet.bands
      • FrequencyBandSet.frequency_grid()
      • FrequencyBandSet.frequency_mask()
      • FrequencyBandSet.global_f_max
      • FrequencyBandSet.global_f_min
      • FrequencyBandSet.is_selective
      • FrequencyBandSet.mode_passes_ms1()
      • FrequencyBandSet.n_bands
      • FrequencyBandSet.summary()
    • PerformanceMetrics
      • PerformanceMetrics.dof_reduction_pct
      • PerformanceMetrics.frf_flops_ref
      • PerformanceMetrics.frf_flops_rom
      • PerformanceMetrics.frf_method
      • PerformanceMetrics.frf_speedup
      • PerformanceMetrics.kappa
      • PerformanceMetrics.mode_retention_pct
      • PerformanceMetrics.n_bands
      • PerformanceMetrics.n_freq_points
      • PerformanceMetrics.n_full_dofs
      • PerformanceMetrics.n_master_dofs
      • PerformanceMetrics.n_selected_modes
      • PerformanceMetrics.summary()
      • PerformanceMetrics.t_dof_select_s
      • PerformanceMetrics.t_eigensolver_s
      • PerformanceMetrics.t_frf_s
      • PerformanceMetrics.t_mode_select_s
      • PerformanceMetrics.t_rom_build_s
      • PerformanceMetrics.t_total_s
    • PipelineResults
      • PipelineResults.config
      • PipelineResults.freqs_hz
      • PipelineResults.phi
      • PipelineResults.selected_modes
      • PipelineResults.master_dofs
      • PipelineResults.T
      • PipelineResults.kappa
      • PipelineResults.freq_errors
      • PipelineResults.max_freq_err
      • PipelineResults.frf
      • PipelineResults.validation
      • PipelineResults.performance
      • PipelineResults.elapsed_total_s
      • PipelineResults.saved_files
      • PipelineResults.Ka
      • PipelineResults.Ma
      • PipelineResults.T
      • PipelineResults.config
      • PipelineResults.elapsed_total_s
      • PipelineResults.freq_errors
      • PipelineResults.freqs_hz
      • PipelineResults.frf
      • PipelineResults.kappa
      • PipelineResults.master_dofs
      • PipelineResults.max_freq_err
      • PipelineResults.performance
      • PipelineResults.phi
      • PipelineResults.saved_files
      • PipelineResults.selected_modes
      • PipelineResults.summary()
      • PipelineResults.validation
    • ROMConfig
      • ROMConfig.bands
      • ROMConfig.damping_type
      • ROMConfig.dof_method
      • ROMConfig.effective_bands
      • ROMConfig.eigsh_sigma
      • ROMConfig.eigsh_tol
      • ROMConfig.export_folder
      • ROMConfig.force_dofs
      • ROMConfig.freq_range
      • ROMConfig.frf_method
      • ROMConfig.global_f_max
      • ROMConfig.global_f_min
      • ROMConfig.is_selective
      • ROMConfig.ke_prescreen_frac
      • ROMConfig.mac_threshold
      • ROMConfig.mass_file
      • ROMConfig.ms1_alpha
      • ROMConfig.ms2_threshold
      • ROMConfig.ms3_threshold
      • ROMConfig.n_bands
      • ROMConfig.n_pairs
      • ROMConfig.n_points_per_band
      • ROMConfig.num_modes_eigsh
      • ROMConfig.output_dofs
      • ROMConfig.plot
      • ROMConfig.rb_hz
      • ROMConfig.save_matrices
      • ROMConfig.save_prefix
      • ROMConfig.stiffness_file
      • ROMConfig.summary()
      • ROMConfig.verbose
      • ROMConfig.zeta
    • SereпPipeline
      • SereпPipeline.run()
    • ValidationReport
      • ValidationReport.eigenvalue_errors_pct
      • ValidationReport.expansion_error
      • ValidationReport.ka_condition_number
      • ValidationReport.ka_positive_definite
      • ValidationReport.ma_condition_number
      • ValidationReport.ma_positive_definite
      • ValidationReport.mac_values
      • ValidationReport.mass_ortho_error
      • ValidationReport.max_eigenvalue_error_pct
      • ValidationReport.mean_eigenvalue_error_pct
      • ValidationReport.mean_mac
      • ValidationReport.min_mac
      • ValidationReport.passed()
      • ValidationReport.stiff_ortho_error
      • ValidationReport.summary()
    • ansys_dof()
    • apply_bcs()
    • bandwidth()
    • build_dof_map()
    • build_rayleigh_damping()
    • build_serep_rom()
    • compare_dof_selectors()
    • compute_frf_direct()
    • compute_frf_direct_fullmodel()
    • compute_frf_modal()
    • compute_frf_modal_reference()
    • compute_frf_pair_direct()
    • condition_number_estimate()
    • diagonal_scaling()
    • dof_count_study()
    • dof_to_ansys()
    • eigenvalue_error()
    • eigenvalue_sensitivity()
    • enforce_symmetry()
    • euler_beam()
    • flop_count()
    • force_positive_definite()
    • frf_sensitivity()
    • is_diagonal()
    • load_frf_npz()
    • load_matrices()
    • load_matrix()
    • load_metrics()
    • load_reduced_matrices()
    • mac_filter()
    • mass_normalise()
    • material_perturbation_study()
    • matrix_stats()
    • memory_mb()
    • modal_assurance_criterion()
    • modal_residues()
    • modal_strain_energy()
    • mode_count_study()
    • model_info()
    • monte_carlo_frf()
    • ms1_frequency_range()
    • ms2_participation_factor()
    • ms3_spatial_amplitude()
    • ms4_conditioning_check()
    • orthogonality_check()
    • plate_2d()
    • plot_dof_selector_comparison()
    • plot_frf_comparison()
    • plot_frf_overlay()
    • plot_mac_matrix()
    • plot_mode_shapes()
    • plot_performance_dashboard()
    • random_symmetric_pd()
    • rank_revealing_qr()
    • reduction_metrics()
    • reorder_rcm()
    • safe_pinv()
    • save_results()
    • select_dofs_eid()
    • select_dofs_kinetic()
    • select_dofs_modal_disp()
    • select_dofs_svd()
    • select_modes()
    • select_modes_pipeline()
    • solve_eigenproblem()
    • sparse_submatrix()
    • sparsity()
    • spring_chain()
    • summarise_performance()
    • symmetrise()
    • unscale_modes()
    • validate_serep()
    • verify_eigenvalues()
    • write_ansys_node_list()
    • write_master_dofs_csv()
    • write_master_dofs_vtk()
    • write_uff58_mode_shapes()
  • Mathematical Theory
    • System Equivalent Reduction Expansion Process (SEREP)
    • Symmetric matrix assumption
      • Generalised eigenvalue problem
      • SEREP transformation
    • Mode Selection
      • MS1 — Frequency range filter
      • MS2 — Band-weighted Modal Participation Factor
      • MS3 — Spatial amplitude at target DOFs
      • MAC Filter
    • DOF Selection
      • DS4 — Effective Independence (Kammer, 1991)
    • Direct FRF Computation
      • Dynamic stiffness matrix
      • Damping models
    • Eigenvalue Sensitivity
      • FRF Sensitivity
    • References
  • Changelog
    • 3.0.0 — 2025
pyserep
  • Search

© Copyright 2025, Krithish Surya.

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