API reference

The public namespaces are edinpy.fermion and edinpy.boson. Classes shared by both namespaces are documented once under Core API. Statistics-specific mode spaces, Fock bases, sectors, and primitive operators are documented under Fermion API and Boson API.

• Core API
  • Degrees of freedom and mode indexing
  • State algebra
  • Symbolic operator algebra
  • Hamiltonian
  • Physical operator builders
• Boson API
  • Bosonic modes, sectors, and basis states
  • Primitive bosonic operators
• Fermion API
  • Fermionic modes, sectors, and basis states
  • Primitive fermionic operators
• Glossary
• Current limitations
  • Symmetry sectors
  • Number-changing Hamiltonians
  • Hermitian eigensolution
  • Dynamics and finite temperature
  • Practical system-size limit
  • Finite-size interpretation