twpasolver package

twpasolver package.

Twpasolver: TWPA Analysis and Simulation Library

twpasolver is a Python library for analyzing and simulating Traveling Wave Parametric Amplifiers (TWPAs) by solving systems of Coupled Mode Equations (CMEs).

Key Features

Extended CME Systems:

• Solve CMEs with arbitrary numbers of modes beyond pump-signal-idler

• Automatic inclusion of pump harmonics, frequency conversion terms, and harmonics

• Support for 3-wave mixing (3WM) and 4-wave mixing (4WM) processes

• Rotating Wave Approximation (RWA) term selection

Mode Management:

• ModeArray class with symbolic frequency dependency tracking

• Automatic mode relationship propagation using dependency graphs

• Support for forward and backward propagating modes

• Parameter interpolation (kappa, gamma, alpha) from base data

Performance:

• Numba-accelerated parallel CME solvers

• Efficient matrix operations for 2x2 ABCD matrices

• Frequency array processing with caching

• Parameter sweeps with result caching

Gain Models:

• MINIMAL_3WM: Basic three-wave mixing model with only pump, signal and idler

• GENERAL_IDEAL: Extended modes without losses or reflections

• GENERAL_LOSS_ONLY: Extended modes with losses

• GENERAL: Full model with losses and reflections

Circuit Modeling:

• Hierarchical composition of one-port and two-port network elements

• Pre-built KITWPA cell models (lumped or distributed elements)

• Custom circuit elements with automatic ABCD matrix computation

Analysis Tools:

• Phase matching analysis with custom mode configurations

• Gain and bandwidth calculations with pump depletion effects

• Parameter sweeps with automatic result caching

• Built-in plotting functions

Core Classes

• TWPAnalysis: Main analysis engine with extended CME support

• ModeArray: Mode relationship handler with symbolic frequency propagation

• TWPA: Nonlinear TWPA model with circuit composition

• ABCDArray: Optimized 2x2 matrix arrays

• TwoPortCell: Network parameter container with format conversion

Usage Examples

See the Tutorials section for detailed examples from simple linear component analysis to complex multi-mode simulations with pump harmonics and frequency conversion processes.

Subpackages

• twpasolver.models package
  • Imports
  • Usage
  • Submodules
    • twpasolver.models.compose module
      • compose()
    • twpasolver.models.modelarray module
      • ModelArray
    • twpasolver.models.oneport module
      • OnePortModel
      • OnePortArray
      • Resistance
      • Capacitance
      • Inductance
      • Stub
    • twpasolver.models.rf_functions module
      • inductance()
      • capacitance()
      • stub()
      • parallel_admittance_abcd()
      • series_impedance_abcd()
      • lossless_line_abcd()
      • LCLf_abcd()
      • get_stub_cell()
    • twpasolver.models.transmission_lines module
      • LosslessTL
    • twpasolver.models.twoportarrays module
      • TwoPortArray
      • TWPA
    • twpasolver.models.twpa_cells module
      • StubBaseCell
      • LCLfBaseCell

Submodules

• twpasolver.analysis module
  • TWPA Analysis and Simulation
    • Key Components
    • Usage Patterns
  • GainModel
    • GainModel.MINIMAL_3WM
    • GainModel.GENERAL_IDEAL
    • GainModel.GENERAL_LOSS_ONLY
    • GainModel.GENERAL
  • prepare_relations_coefficients()
  • analysis_function()
  • Analyzer
    • Analyzer.data_file
    • Analyzer.data
    • Analyzer.update_base_data()
    • Analyzer.save_data()
    • Analyzer.load_data()
    • Analyzer.parameter_sweep()
  • TWPAnalysis
    • TWPAnalysis.twpa
    • TWPAnalysis.load_model_from_file
    • TWPAnalysis.update_base_data()
    • TWPAnalysis.get_mode_array()
    • TWPAnalysis.add_mode_array()
    • TWPAnalysis.phase_matching()
    • TWPAnalysis.gain()
    • TWPAnalysis.bandwidth()
    • TWPAnalysis.plot_response()
    • TWPAnalysis.plot_gain()
    • TWPAnalysis.plot_mode_currents()
    • TWPAnalysis.plot_phase_matching()
    • TWPAnalysis.model_post_init()
• twpasolver.basemodel module
  • BaseModel
    • BaseModel.model_dump()
    • BaseModel.from_file()
    • BaseModel.dump_to_file()
• twpasolver.bonus_types module
  • all_subclasses()
  • validate_impedance()
• twpasolver.cmes module
  • CMEode_complete()
  • general_cme_ideal()
  • general_cme_loss_only()
  • general_cme()
  • cme_general_solve_freq_array_ideal()
  • cme_general_solve_freq_array_loss()
  • cme_general_solve_freq_array_full()
  • cme_general_solve_freq_array()
  • cme_solve()
• twpasolver.file_utils module
  • read_file()
  • save_to_file()
  • add_extension()
  • ensure_directory_exists()
  • read_hdf5()
  • read_json()
  • save_to_hdf5()
  • save_to_json()
  • NpEncoder
    • NpEncoder.default()
• twpasolver.frequency module
  • Frequencies
    • Frequencies.f_list
    • Frequencies.f_arange
    • Frequencies.unit
    • Frequencies.f
    • Frequencies.omega
    • Frequencies.unit_multiplier
    • Frequencies.model_post_init()
• twpasolver.logger module
  • CustomHandler
    • CustomHandler.format()
• twpasolver.mathutils module
  • matmul_2x2()
  • matpow_2x2()
  • a2s()
  • s2a()
  • a2z()
  • z2a()
  • to_dB()
  • dBm_to_I()
  • I_to_dBm()
  • compute_phase_matching()
• twpasolver.matrices_arrays module
  • TwoByTwoArray
    • TwoByTwoArray.shape
    • TwoByTwoArray.len
  • ABCDArray
    • ABCDArray.A
    • ABCDArray.B
    • ABCDArray.C
    • ABCDArray.D
  • SMatrixArray
    • SMatrixArray.S11
    • SMatrixArray.S12
    • SMatrixArray.S21
    • SMatrixArray.S22
  • ZMatrixArray
    • ZMatrixArray.Z11
    • ZMatrixArray.Z12
    • ZMatrixArray.Z21
    • ZMatrixArray.Z22
  • abcd_identity()
• twpasolver.modes_rwa module
  • Mode Management and Rotating Wave Approximation Analysis
    • Key Components
    • Capabilities
    • Performance Notes
  • ParameterInterpolator
    • ParameterInterpolator.get_parameters()
  • Mode
    • Mode.label
    • Mode.direction
    • Mode.frequency
    • Mode.k
    • Mode.gamma
    • Mode.alpha
  • RWAAnalyzer
    • RWAAnalyzer.relations
    • RWAAnalyzer.update_relations()
    • RWAAnalyzer.find_rwa_terms()
    • RWAAnalyzer.print_rwa_terms()
  • ModeArray
    • ModeArray.update_frequencies()
    • ModeArray.update_base_data()
    • ModeArray.process_frequency_array()
    • ModeArray.plot_mode_relations()
    • ModeArray.get_mode()
    • ModeArray.get_rwa_terms()
    • ModeArray.print_modes()
    • ModeArray.print_symbolic_expressions()
  • ModeArrayFactory
    • ModeArrayFactory.create_basic_3wm()
    • ModeArrayFactory.create_extended_3wm()
    • ModeArrayFactory.create_custom()
• twpasolver.plotting module
  • plot_mode_currents()
  • plot_response()
  • plot_gain()
  • plot_phase_matching()
• twpasolver.twoport module
  • TwoPortCell
    • TwoPortCell.from_s()
    • TwoPortCell.from_z()
    • TwoPortCell.from_file()
    • TwoPortCell.freqs
    • TwoPortCell.Z0
    • TwoPortCell.to_network()
    • TwoPortCell.s
    • TwoPortCell.z
    • TwoPortCell.as_dict()
    • TwoPortCell.dump_to_file()
    • TwoPortCell.interpolate()
  • TwoPortModel
    • TwoPortModel.Z0_ref
    • TwoPortModel.N
    • TwoPortModel.update()
    • TwoPortModel.single_abcd()
    • TwoPortModel.get_abcd()
    • TwoPortModel.get_cell()
    • TwoPortModel.get_network()