LatticeQM Documentation

LatticeQM is a Julia toolkit for building lattice models, constructing tight-binding Hamiltonians, and analysing electronic structure across a broad set of workflows (band structures, topology, mean-field, Floquet dynamics).

Choose your path

• Getting Started — installation, environment setup, and a five-minute graphene example.
• Tutorials — guided Jupyter notebooks spanning lattice construction to Floquet physics.
• Concept Guides — deeper discussions of geometry, operator construction, observables, and interactions.
• Advanced Workflows — performance tuning, batch runs, and data management strategies.
• API Reference — auto-generated listings of exported names once docstrings are standardised.
• Contributor Guide — development workflow, testing, and release coordination.

What you'll find here

• Physics-driven examples: graphene, multilayer systems, twisted bilayers, Hubbard mean-field, and Floquet drives.
• Executable walkthroughs: tutorial pages run during the doc build, regenerating lightweight figures and outputs.
• Extensible architecture: modular subpackages (Structure, Spectrum, Meanfield, Floquet, etc.) designed to be recombined.

Staying up to date

• When new capabilities land (e.g. superconductivity utilities, advanced Berry diagnostics), open an issue or discussion to suggest additional examples.

• Getting started
• • Choose your environment
  • Option A — Docker quickstart
  • Option B — VS Code Remote Containers
  • Option C — Native Julia installation
  • Five-minute graphene example
  • Troubleshooting
  • Next steps
• Tutorials Overview
• • Running the notebooks
  • Tutorial roadmap
• Concept Guide — Geometry & Lattices
• • Core types
  • Constructing lattices
  • Neighbours and symmetry
  • Visualisation
  • Best practices
• Advanced Workflows
• • Performance playbook
  • Parallel & HPC execution
  • Data management
  • Troubleshooting checklist
  • Work-in-progress tracking
• Contributor Guide
• • Development setup
  • Coding standards
  • Documentation workflow
  • Branching and commits
  • Review checklist
  • Release coordination
  • Getting help
• API Reference
• • Structure
  • TightBinding
  • Operators
  • Spectrum
  • LinearResponse
  • Meanfield
  • Superconductivity
  • Floquet
  • Parallel
  • Plotting
  • Utils
  • Common Entrypoints

Acknowledgements

• I thank Dr. Oded Zilberberg and Dr. Gianni Blatter for their guidance and support as my thesis advisors; I developed the package in the course of my PhD research.
• Tobias Kästli (@vigoleis) contributed the Floquet module as part of his Master's project and authored the accompanying tutorial.

Author

• Dr. Tobias Wolf