schr package

Subpackages

• schr.core package
  • Submodules
    • schr.core.base module
      • Field
      • Hamiltonian
      • Solver
  • Module contents
    • Field
      • Field.dtype
      • Field.get_state()
      • Field.set_state()
    • Hamiltonian
      • Hamiltonian.dtype
      • Hamiltonian.apply()
      • Hamiltonian.energy()
    • Solver
      • Solver.hamiltonian
      • Solver.dtype
      • Solver.evolve()
      • Solver.step()
• schr.qed package
  • Submodules
    • schr.qed.field module
      • PhotonField
    • schr.qed.interaction module
      • CoupledQEDSystem
      • minimal_coupling_hamiltonian()
  • Module contents
    • CoupledQEDSystem
      • CoupledQEDSystem.electron_hamiltonian
      • CoupledQEDSystem.photon_field
      • CoupledQEDSystem.coupling_strength
      • CoupledQEDSystem.hbar
      • CoupledQEDSystem.evolve()
      • CoupledQEDSystem.interaction_term()
      • CoupledQEDSystem.total_energy()
    • PhotonField
      • PhotonField.n_modes
      • PhotonField.max_photons
      • PhotonField.frequencies
      • PhotonField.state
      • PhotonField.dtype
      • PhotonField.annihilation_operator()
      • PhotonField.creation_operator()
      • PhotonField.expectation_photon_number()
      • PhotonField.get_state()
      • PhotonField.hamiltonian()
      • PhotonField.number_operator()
      • PhotonField.set_state()
    • minimal_coupling_hamiltonian()
• schr.qm package
  • Submodules
    • schr.qm.hamiltonian module
      • FreeParticle
      • HarmonicOscillator
      • ParticleInPotential
    • schr.qm.solvers module
      • CrankNicolson
      • RungeKutta4
      • SplitStepFourier
      • compute_energy()
      • compute_norm()
      • estimate_stable_timestep()
    • schr.qm.wavefunction module
      • gaussian_wavepacket()
      • normalize()
      • plane_wave()
      • probability_current_1d()
      • probability_density()
  • Module contents
    • CrankNicolson
      • CrankNicolson.step()
    • FreeParticle
    • HarmonicOscillator
    • ParticleInPotential
      • ParticleInPotential.potential
      • ParticleInPotential.mass
      • ParticleInPotential.hbar
      • ParticleInPotential.dx
      • ParticleInPotential.kinetic_operator
      • ParticleInPotential.apply()
      • ParticleInPotential.energy()
      • ParticleInPotential.kinetic_energy()
      • ParticleInPotential.potential_energy()
    • RungeKutta4
      • RungeKutta4.step()
    • SplitStepFourier
      • SplitStepFourier.hamiltonian
      • SplitStepFourier.hbar
      • SplitStepFourier.kinetic_operator
      • SplitStepFourier.step()
    • estimate_stable_timestep()
    • gaussian_wavepacket()
    • normalize()
• schr.utils package
  • Submodules
    • schr.utils.absorbing_boundary module
      • complex_absorbing_potential()
      • create_absorbing_boundary()
      • create_absorption_mask()
      • exponential_absorbing_mask()
      • mask_absorbing_potential()
      • polynomial_absorbing_mask()
    • schr.utils.fft module
      • fft_derivative()
      • fftfreq_grid()
      • momentum_operator()
    • schr.utils.grid module
      • create_grid_1d()
      • create_grid_2d()
      • create_grid_3d()
    • schr.utils.paths module
      • clean_old_simulations()
      • get_cache_dir()
      • get_data_dir()
      • get_output_dir()
      • get_output_path()
      • get_schr_home()
      • get_simulation_info()
      • list_simulations()
    • schr.utils.visualization module
      • animate_wavefunction()
      • animate_wavefunction_2d()
      • plot_wavefunction()
      • plot_wavefunction_2d()
      • plot_wavefunction_2d_comprehensive()
      • plot_wavefunction_3d()
      • plot_wavefunction_components()
  • Module contents
    • animate_wavefunction()
    • animate_wavefunction_2d()
    • clean_old_simulations()
    • complex_absorbing_potential()
    • create_absorbing_boundary()
    • create_absorption_mask()
    • create_grid_1d()
    • create_grid_2d()
    • create_grid_3d()
    • exponential_absorbing_mask()
    • fft_derivative()
    • fftfreq_grid()
    • get_cache_dir()
    • get_data_dir()
    • get_output_dir()
    • get_output_path()
    • get_schr_home()
    • get_simulation_info()
    • list_simulations()
    • mask_absorbing_potential()
    • momentum_operator()
    • plot_wavefunction()
    • plot_wavefunction_2d()
    • polynomial_absorbing_mask()

Module contents

schr: A Python framework for Quantum Mechanics and QED simulations.

This package provides GPU-accelerated quantum simulations using JAX, with modules for quantum mechanics (QM) and quantum electrodynamics (QED).