StarkZee

Getting started

  • Installation
    • Requirements
    • Install
    • Running the tests
    • Command-line interface
  • Quick start
    • Basic profile
    • Discrete transition stick spectrum
    • Balmer series at once
    • Lower-level API
    • FFM (dynamic ion) profile
    • Post-processing: Doppler and instrumental broadening

Manual

  • Introduction
  • Calculation Workflow and Package Map
  • Physics and Numerical Formulation
    • Liouville Space Representation
      • From propagator to resolvent.
      • Field-dependent Liouvillian and static profile.
    • Radiator Hamiltonian in Magnetic Fields
      • Unperturbed Hydrogenic Energy (\(H_0\))
      • Spin-Orbit Coupling (\(H_{\rm SO}\))
      • Fine-Structure Relativistic Corrections (\(H_{\rm FS}\))
      • Linear Zeeman Effect (\(H_Z^{(1)}\))
      • Quadratic (Diamagnetic) Zeeman Effect (\(H_Z^{(2)}\))
    • Empirical Field-Free Energies
    • Full Electron-Radiator Hamiltonian
      • Stark Perturbation Matrix Elements
      • Radial matrix element.
      • Angular matrix elements.
    • Transition Dipole Operator
      • Angular Dipole Matrix Elements
      • Hydrogenic Radial Dipole Integrals (Gordon’s Formula)
    • Diagonalization and Transition Dipole Basis Rotation
    • Plasma Microfield Distributions
      • The Hooper Screened Microfield Distribution
      • The Potekhin Microfield Distribution
      • Quadrature Discretization
    • Electron Impact Broadening
      • Liouville-space structure of \(\Phi(\omega)\) and connection to \(\langle r^2\rangle\)
      • Shell-average approximation.
      • Density-Temperature Prefactor
      • Shell-Averaged Mean-Square Radius
      • Strong-Collision Constant
      • Dynamical GBK Factor
      • Cutoff frequency.
      • Frequency-dependent vs. resonance-center width.
      • ZEST electron broadening variant (electron_model=’zest’)
      • Physical justification — \(\Delta n = 0\) interaction channels.
      • Intra-shell squared radius.
      • Maximum wave-number cutoff \(\kappa_m\).
      • G-function choices (electron_model selector).
    • Profile Accumulation
    • Frequency Fluctuation Model (FFM)
    • Thermal Doppler Broadening
      • FFM path (calculate_ffm_profile)
      • Static profile path (calculate_static_profile)
  • Approximations and Numerical Choices
  • Built-in Reference Models
    • Tabulated Models
      • Stehlé (MMM) — stehle
      • Rosato — rosato
    • Analytical Models
      • Lomanowski — lomanowski
      • Parameterized Stehlé — stehle_param
      • Voigt — voigt
    • Comparison with StarkZee
  • Physical Approximations and Domains of Validity
  • Physics Explanation of Use Cases and Operational Limits
    • The High-Magnetic-Field Regime
    • Density Limits
  • References

Examples

  • Examples
    • Balmer series — LineProfile class
    • Hα stick spectrum and broadened profile
    • Transition anatomy
    • Reproducing Figure 1 from Ferri et al. (2022)
    • Satellite features at B = 1000 T
    • Quadratic Zeeman polarization wings
    • Lyman-α at high B

API reference

  • API reference
    • line_profile
      • DiscreteTransitions
        • DiscreteTransitions.energy_ev
        • DiscreteTransitions.detuning_ev
        • DiscreteTransitions.wavelength_nm
        • DiscreteTransitions.frequency_thz
        • DiscreteTransitions.wavenumber_cm
        • DiscreteTransitions.q
        • DiscreteTransitions.strength
        • DiscreteTransitions.upper_idx
        • DiscreteTransitions.lower_idx
      • LineProfile
        • LineProfile.GRID_TYPES
        • LineProfile.compute_profile()
        • LineProfile.compute_discrete()
        • LineProfile.profile_transverse
        • LineProfile.profile_parallel
        • LineProfile.profile_at_angle()
    • static_profile
      • build_stark_matrix()
      • solve_starkzee()
      • calculate_static_profile()
      • discrete_transitions()
    • ffm
      • calculate_ion_fluctuation_rate()
      • calculate_ffm_profile()
    • radiator
      • AtomicState
        • AtomicState.index
        • AtomicState.n
        • AtomicState.l
        • AtomicState.ml
        • AtomicState.s
        • AtomicState.ms
      • build_basis()
      • radial_wavefunction()
      • radial_r2_element()
      • set_radial_dipole_method()
      • radial_dipole()
      • angular_dipole_element()
      • build_hamiltonian()
      • diagonalize_hamiltonian()
      • dipole_matrix_elements()
      • line_strength()
      • oscillator_strength()
      • einstein_a()
    • microfield
      • calculate_normal_field()
      • calculate_debye_length()
      • calculate_multispecies_debye_length()
      • calculate_coupling_parameter()
      • holtsmark_distribution()
      • hooper_distribution()
      • potekhin_distribution()
      • microfield_quadrature()
    • broadening
      • calculate_plasma_frequency()
      • calculate_larmor_frequency()
      • calculate_configuration_frequency()
      • calculate_debye_length()
      • calculate_cutoff_kappa_m()
      • calculate_electron_impact_prefactor()
      • gbk_model()
      • gbk_zest_model()
      • lee_model()
      • dufty_model()
      • electron_impact_width()
      • electron_impact_width_zest()
      • electron_impact_width_model()
      • electron_impact_r2_scaling()
    • convolutions
      • calculate_doppler_width_ev()
      • convolve_fft()
      • apply_doppler_broadening()
      • apply_instrument_broadening()
    • utils
      • species_to_ZA()
      • nuclear_mass_kg()
      • reduced_mass_rydberg_ev()
      • temp_ev_to_joules()
      • temp_ev_to_kelvin()
      • energy_ev_to_wavelength_nm()
      • vacuum_to_air_wavelength_nm()
      • wavelength_nm_to_energy_ev()
      • frequency_thz_to_energy_ev()
      • energy_ev_to_frequency_thz()
      • wavenumber_cm_to_energy_ev()
      • energy_ev_to_wavenumber_cm()
    • atomic_data
      • AtomicState
        • AtomicState.energy
        • AtomicState.n
        • AtomicState.l
        • AtomicState.j
        • AtomicState.spin
      • get_data_path()
      • load_levels()
      • calculate_wavenumber()
    • Module overview
StarkZee
  • Search

© Copyright 2025, G. Ronchi.

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