zkit

Getting started

  • Installation
  • Quickstart

User guide

  • Command-line interface
  • Python API
  • Input and output formats
  • Wavefunctions
  • Transition dipole moments
  • Wigner and phase-space analysis
  • Visualization
  • Physics outputs
  • Troubleshooting

Examples

  • Examples
    • Realistic post-processing campaign
    • Transition-dipole campaign
    • Wigner campaign
    • Quick oscillator, heterostructure, and dynamics examples

Reference

  • API reference
zkit
  • Examples
  • View page source

Examples

This section contains reproducible workflows showing how to use zkit with TDSEZ outputs. The quick examples are designed as smoke tests: they run in seconds, produce publication-style plots, and exercise static eigenvalue, heterostructure, reconstruction, and time-dependent analysis paths.

  • Realistic post-processing campaign
    • Run setup
    • 1. Summarize the run
    • 2. Load everything in Python
    • 3. Inspect the spectrum
    • 4. Plot energy over time
    • 5. Plot dipole and acceleration
    • 6. Inspect populations
    • 7. Reconstruct and plot wavefunctions
    • 8. Reconstruct selected eigenstates
    • 9. Check norm conservation
    • 10. Export selected snapshots to VTK for ParaView
    • Resulting artifacts
  • Transition-dipole campaign
    • Data
    • 1. Read the spectrum
    • 2. Read the full TDM
    • 3. Extract strongest couplings from ground state
    • 4. Plot a filtered transition diagram
    • 5. Plot a heatmap
    • 6. Oscillator strength summary
    • 7. Save selected tables
  • Wigner campaign
    • Data
    • 1. Load snapshots
    • 2. Reconstruct each snapshot on a phase-space grid
    • 3. Compute marginal Wigner function
    • 4. Measure nonclassicality
    • 5. Phase-space current
    • 6. Autocorrelation decay
    • 7. Campaign report
  • Quick oscillator, heterostructure, and dynamics examples
    • Driven dynamics and Rabi-style transfer
    • Rabi-flopping suite
    • Three-dimensional reconstruction
Previous Next

© Copyright 2026, Dr. Zakaria Dahbi.