API reference

This section documents the main zkit modules and classes. Use sphinx.ext.autodoc to render signatures and docstrings directly from the source.

zkit.io

• zkit.io.eigen
  • read_eigen()
• zkit.io.evolution
  • read_evolution()
• zkit.io.ts
  • read_timeseries()
• zkit.io.wavefunction
  • read_wfs()
• zkit.io.wfs_field
  • reconstruct_wfs()
  • reconstruct_static_wfs()
  • wfs_to_vtk()
  • compute_wfs_norm()
• zkit.io.tdm
  • read_tdm()
  • tdm_of_state()
  • tdm_magnitude_of_state()
• zkit.io.base
  • list_datasets()
  • dataset_shape()
  • read_dataset()
  • detect_dimension()

zkit.viz

• zkit.viz
  • zkit.viz.wavefunction
  • zkit.viz.tdm

zkit.simulation

• zkit.simulation
  • Run
  • Simulation
  • load()

zkit.physics

• zkit.physics
  • Physics
  • parse_expression()

zkit.mwigner

• zkit.mwigner
  • zkit.mwigner.transform
  • zkit.mwigner.current
  • zkit.mwigner.covariance
  • zkit.mwigner.autocorr
  • zkit.mwigner.analysis