Public API Reference

This generated inventory covers every symbol exported from quantum_lattice_models. Focused model imports under quantum_lattice_models.models are recommended when a workflow only needs one physical domain.

Name	Kind	Defined in	Summary
`ANALYSIS_SCHEMA_VERSION`	constant	`quantum_lattice_models`	str(object='') -> str
`AdapterCapabilityReport`	class	`quantum_lattice_models.intake`	Report what a model translation target can preserve.
`AnalysisResult`	class	`quantum_lattice_models.analysis`	Portable numerical result with coordinates, provenance, and plot metadata.
`BASIS_MAPPING_ROLES`	constant	`quantum_lattice_models`	Built-in immutable sequence.
`BandStructure`	class	`quantum_lattice_models.periodic`	Band energies and optional eigenvectors sampled over momentum.
`BasisIndexMapping`	class	`quantum_lattice_models.physical`	Map one local degree to a basis factor, mode, or single-particle index.
`Bond`	class	`quantum_lattice_models.lattice`	A directed edge between two lattice sites with an optional matrix element.
`BoseHubbardSector`	class	`quantum_lattice_models.boson_sector`	BoseHubbardSector(matrix: 'sp.csr_matrix', basis: 'FixedParticleNumberBasis', parameters: 'dict[str, object]')
`CellBond`	class	`quantum_lattice_models.periodic`	A directed hopping from one orbital to an orbital in a displaced cell.
`ConservedQuantity`	class	`quantum_lattice_models.conserved`	Named operator with optional sector and convention metadata.
`EXPORT_ARTIFACTS`	constant	`quantum_lattice_models`	Built-in immutable sequence.
`EXTERNAL_MATRIX_FAMILY`	constant	`quantum_lattice_models`	str(object='') -> str
`FermiHubbardBasis`	class	`quantum_lattice_models.fermion_sector`	Occupation basis with fixed up- and down-spin particle numbers.
`FermiHubbardSector`	class	`quantum_lattice_models.fermion_sector`	Sparse Fermi-Hubbard Hamiltonian and its explicit reduced basis.
`FixedMagnetizationBasis`	class	`quantum_lattice_models.spin`	Computational basis restricted to a total Pauli-Z eigenvalue.
`FixedParticleNumberBasis`	class	`quantum_lattice_models.boson_sector`	FixedParticleNumberBasis(n_sites: 'int', n_particles: 'int', max_occupancy: 'int', states: 'tuple[tuple[int, ...], ...]')
`GRAPH_SPIN_FAMILY`	constant	`quantum_lattice_models`	str(object='') -> str
`HamiltonianResult`	class	`quantum_lattice_models.types`	Hamiltonian matrix together with portable construction metadata.
`InteractionTerm`	class	`quantum_lattice_models.physical`	Portable onsite or two-body operator term.
`LOCAL_DEGREE_KINDS`	constant	`quantum_lattice_models`	Built-in immutable sequence.
`Lattice`	class	`quantum_lattice_models.lattice`	Finite lattice geometry for user-defined single-particle models.
`LatticeSpec`	class	`quantum_lattice_models.specs`	Portable finite-lattice geometry and metadata.
`LocalDegreeOfFreedom`	class	`quantum_lattice_models.physical`	One indexed local physical degree of freedom.
`MatrixDiagnostics`	class	`quantum_lattice_models.diagnostics`	Summary of matrix structure, storage, and Hermiticity.
`ModelComparison`	class	`quantum_lattice_models.comparison`	Parameters, matrix, spectrum, and gap comparison for two models.
`ModelInspection`	class	`quantum_lattice_models.diagnostics`	Pre-build model dimension, storage, basis, and warning report.
`ModelLintReport`	class	`quantum_lattice_models.intake`	Validation and consistency report for model intake workflows.
`ModelPreset`	class	`quantum_lattice_models._registry_core`	Named parameter set for a canonical phase or reference limit.
`ModelSpec`	class	`quantum_lattice_models.specs`	Portable registered-model parameters and optional lattice geometry.
`ModelSummary`	class	`quantum_lattice_models.intake`	User-facing summary of a portable model or Hamiltonian result.
`MomentumPath`	class	`quantum_lattice_models.periodic`	Sampled momentum path with labeled high-symmetry vertices.
`MultiPanelPlotSpec`	class	`quantum_lattice_models.visual_export`	Declarative layout for several named portable analysis panels.
`PLUGIN_API_VERSION`	constant	`quantum_lattice_models`	str(object='') -> str
`PeriodicLatticeSpec`	class	`quantum_lattice_models.periodic`	Portable translationally invariant single-particle lattice model.
`ReducedBasisMapping`	class	`quantum_lattice_models.reduced`	Explicit row-to-full-state mapping for a symmetry-reduced basis.
`SPEC_SCHEMA_VERSION`	constant	`quantum_lattice_models`	str(object='') -> str
`SpinField`	class	`quantum_lattice_models.spin`	One site-resolved Pauli field.
`SpinInteraction`	class	`quantum_lattice_models.spin`	One two-site Pauli interaction on an arbitrary spin graph.
`SpinSectorHamiltonian`	class	`quantum_lattice_models.spin`	Sparse Hamiltonian and explicit basis for a conserved spin sector.
`TightBindingModel`	class	`quantum_lattice_models.lattice`	Build single-particle tight-binding Hamiltonians on a finite lattice.
`adapter_capability_report`	function	`quantum_lattice_models.intake`	Report whether a target adapter can preserve key model semantics.
`add_lattice_bonds`	function	`quantum_lattice_models.transformations`	Append validated bonds to a lattice.
`add_long_range_bonds`	function	`quantum_lattice_models.transformations`	Generate directed bonds by Euclidean distance with optional power-law decay.
`anderson_chain`	function	`quantum_lattice_models.benchmarks`	Return a reproducible one-dimensional Anderson model.
`anderson_square_lattice`	function	`quantum_lattice_models.benchmarks`	Return a reproducible two-dimensional Anderson model.
`anderson_square_lattice_sparse`	function	`quantum_lattice_models.benchmarks`	Return a sparse two-dimensional Anderson Hamiltonian.
`apply_bond_disorder`	function	`quantum_lattice_models.transformations`	Perturb explicit bond matrix elements reproducibly.
`apply_domain_wall`	function	`quantum_lattice_models.transformations`	Add a step-like onsite potential across a spatial domain wall.
`apply_impurity_potential`	function	`quantum_lattice_models.transformations`	Add site-selective impurity potentials to portable onsite metadata.
`apply_interface`	function	`quantum_lattice_models.transformations`	Apply a sharp or linearly interpolated onsite interface.
`apply_onsite_disorder`	function	`quantum_lattice_models.transformations`	Attach reproducible onsite disorder values to lattice metadata.
`apply_spatial_potential`	function	`quantum_lattice_models.transformations`	Add a continuously varying onsite potential evaluated at each coordinate.
`apply_twisted_boundary`	function	`quantum_lattice_models.transformations`	Apply a phase twist to bonds crossing a selected finite-lattice boundary.
`aubry_andre_harper_chain`	function	`quantum_lattice_models.tight_binding`	Return the single-particle Aubry-Andre-Harper tight-binding matrix.
`available_representations`	function	`quantum_lattice_models.registry`	Return matrix representations available for a logical model.
`band_structure_result`	function	`quantum_lattice_models.analysis`	Convert a band structure into a portable analysis result.
`berry_curvature`	function	`quantum_lattice_models.advanced`	Return gauge-invariant plaquette Berry curvature over a reciprocal mesh.
`berry_curvature_convergence`	function	`quantum_lattice_models.advanced`	Report Chern-number convergence across reciprocal meshes.
`bipartite_entanglement_entropy`	function	`quantum_lattice_models.observables`	Return the von Neumann entropy of a spin subsystem.
`bond_current`	function	`quantum_lattice_models.observables`	Return the oriented single-particle bond current `2 Im(t ψ_i* ψ_j)`.
`bose_hubbard_chain`	function	`quantum_lattice_models.hubbard`	Return a dense truncated Bose-Hubbard chain Hamiltonian.
`bose_hubbard_chain_sector`	function	`quantum_lattice_models.boson_sector`	Public package symbol.
`bose_hubbard_chain_sparse`	function	`quantum_lattice_models.hubbard`	Return a sparse truncated Bose-Hubbard chain Hamiltonian.
`boson_site_occupations`	function	`quantum_lattice_models.boson_sector`	Public package symbol.
`canonical_model_name`	function	`quantum_lattice_models.registry`	Return the logical model name for a registered name or alias.
`checkerboard_chern_insulator`	function	`quantum_lattice_models.benchmarks`	Return a two-orbital square-lattice Chern-insulator benchmark.
`checkerboard_chern_insulator_sparse`	function	`quantum_lattice_models.benchmarks`	Return the sparse real-space two-band Chern-insulator matrix.
`chern_number`	function	`quantum_lattice_models.topology`	Return the Fukui-Hatsugai-Suzuki Chern number on a periodic momentum mesh.
`chern_number_result`	function	`quantum_lattice_models.topology`	Return the occupied-subspace Chern number as a portable analysis result.
`commutator_diagnostic`	function	`quantum_lattice_models.conserved`	Measure `[H, Q]` and report whether `Q` is conserved.
`compare_models`	function	`quantum_lattice_models.comparison`	Compare model metadata and, when safe, matrices and spectra.
`connected_spin_correlation_matrix`	function	`quantum_lattice_models.observables`	Return connected same-axis spin correlations.
`correlation_zz`	function	`quantum_lattice_models.observables`	Return the two-point `<Z_i Z_j>` correlation.
`create_graph_spin_spec`	function	`quantum_lattice_models.specs`	Create a portable arbitrary spin-1/2 interaction-graph specification.
`create_model_from_preset`	function	`quantum_lattice_models.specs`	Create a model specification from a named preset with optional overrides.
`create_model_spec`	function	`quantum_lattice_models.specs`	Create a validated specification using registered defaults.
`creutz_ladder`	function	`quantum_lattice_models.benchmarks`	Return a two-leg Creutz ladder with complex leg hoppings.
`custom_tight_binding`	function	`quantum_lattice_models.lattice`	Return a dense single-particle Hamiltonian on a user-defined graph.
`custom_tight_binding_sparse`	function	`quantum_lattice_models.lattice`	Return a sparse single-particle Hamiltonian on a user-defined graph.
`describe_model`	function	`quantum_lattice_models.intake`	Return a compact user-facing description of a model or Hamiltonian result.
`diagnose_matrix`	function	`quantum_lattice_models.diagnostics`	Return a compact structural diagnostic summary.
`dice_lattice`	function	`quantum_lattice_models.benchmarks`	Return a finite dice/T3 lattice with one hub and two rim sites per cell.
`dice_lattice_sparse`	function	`quantum_lattice_models.benchmarks`	Return a sparse finite dice/T3 lattice Hamiltonian.
`estimate_dense_memory`	function	`quantum_lattice_models.diagnostics`	Return bytes required for a square dense matrix.
`estimate_model_dimension`	function	`quantum_lattice_models.diagnostics`	Estimate a registered model's matrix dimension from its dimension expression.
`evolve_state`	function	`quantum_lattice_models.advanced`	Evolve a state under a time-independent Hamiltonian.
`evolve_time_dependent`	function	`quantum_lattice_models.advanced`	Evolve under `H(t)` using piecewise midpoint or fourth-order propagation.
`expectation`	function	`quantum_lattice_models.observables`	Return `<state\|operator\|state>` for a state vector.
`export_analysis_pdf`	function	`quantum_lattice_models.visual_export`	Render any supported portable analysis plot to PDF.
`export_analysis_svg`	function	`quantum_lattice_models.visual_export`	Render any supported portable analysis plot to SVG.
`export_band_data`	function	`quantum_lattice_models.visual_export`	Export band coordinates and energies as deterministic JSON or CSV.
`export_graphml`	function	`quantum_lattice_models.interchange`	Export a lattice as GraphML through the optional NetworkX dependency.
`export_hamiltonian_artifact`	function	`quantum_lattice_models.storage`	Export one portable artifact or a deterministic directory bundle.
`export_interaction_plot_data`	function	`quantum_lattice_models.visual_export`	Export physical degrees and interaction edges as deterministic JSON.
`export_interaction_svg`	function	`quantum_lattice_models.visual_export`	Export a portable physical interaction graph as deterministic SVG.
`export_lattice_csv`	function	`quantum_lattice_models.interchange`	Export site and bond tables plus a metadata sidecar.
`export_lattice_dot`	function	`quantum_lattice_models.adapters`	Export a deterministic Graphviz DOT interaction graph.
`export_lattice_plot_data`	function	`quantum_lattice_models.visual_export`	Export lattice site and bond coordinates as JSON or a single CSV table.
`export_lattice_svg`	function	`quantum_lattice_models.visual_export`	Export a finite lattice diagram as dependency-free deterministic SVG.
`export_lattice_xyz`	function	`quantum_lattice_models.adapters`	Export lattice coordinates to XYZ with labels as element-like tokens.
`export_matrix_plot_data`	function	`quantum_lattice_models.visual_export`	Export matrix real, imaginary, magnitude, phase, and sparsity arrays as JSON.
`export_model_yaml`	function	`quantum_lattice_models.adapters`	Export a model specification through the optional PyYAML adapter.
`export_periodic_svg`	function	`quantum_lattice_models.visual_export`	Export a repeated two-dimensional unit-cell diagram as SVG.
`export_table_json`	function	`quantum_lattice_models.adapters`	Export named coordinates and values as deterministic plot-data JSON.
`fermi_hubbard_basis`	function	`quantum_lattice_models.fermion_sector`	Return spinful occupation states with fixed `N_up` and `N_down`.
`fermi_hubbard_chain`	function	`quantum_lattice_models.hubbard`	Return a dense spinful Fermi-Hubbard chain in occupation-number basis.
`fermi_hubbard_chain_sector`	function	`quantum_lattice_models.fermion_sector`	Build a spinful Fermi-Hubbard chain in a fixed `(N_up, N_down)` sector.
`fermi_hubbard_chain_sector_sparse`	function	`quantum_lattice_models.fermion_sector`	Registered sparse alias for :func:`fermi_hubbard_chain_sector`.
`fermi_hubbard_chain_sparse`	function	`quantum_lattice_models.hubbard`	Return a sparse spinful Fermi-Hubbard chain Hamiltonian.
`fermi_hubbard_observables`	function	`quantum_lattice_models.fermion_sector`	Return site occupations, spin density, and double occupancy.
`finite_size_sweep`	function	`quantum_lattice_models.advanced`	Evaluate a scalar quantity over finite system sizes.
`fixed_magnetization_basis`	function	`quantum_lattice_models.spin`	Return basis states with `sum_i Z_i = magnetization`.
`fixed_particle_number_basis`	function	`quantum_lattice_models.boson_sector`	Public package symbol.
`from_ase`	function	`quantum_lattice_models.adapters`	Translate an ASE `Atoms` object into coordinate-only portable geometry.
`from_networkx`	function	`quantum_lattice_models.interchange`	Construct a portable lattice specification from a NetworkX graph.
`gap_closing_points`	function	`quantum_lattice_models.advanced`	Identify threshold crossings and local minima in sampled spectral gaps.
`get_model_info`	function	`quantum_lattice_models.registry`	Return metadata for a registered model.
`get_preset`	function	`quantum_lattice_models.registry`	Return one named model preset.
`graph_spin_hamiltonian`	function	`quantum_lattice_models.spin`	Build a dense graph spin Hamiltonian through the shared sparse backend.
`graph_spin_hamiltonian_sparse`	function	`quantum_lattice_models.spin`	Build a sparse spin-1/2 Hamiltonian directly from graph interactions.
`graph_spin_model_sector`	function	`quantum_lattice_models.spin`	Build a fixed-magnetization sector directly from a portable graph-spin model.
`graph_spin_sector`	function	`quantum_lattice_models.spin`	Project a magnetization-conserving arbitrary spin graph without densifying.
`graph_spin_subgraph`	function	`quantum_lattice_models.transformations`	Return a graph-spin model with geometry and interactions remapped together.
`graphene_lattice`	function	`quantum_lattice_models.benchmarks`	Return a finite nearest-neighbor graphene/honeycomb Hamiltonian.
`graphene_lattice_sparse`	function	`quantum_lattice_models.benchmarks`	Return a sparse finite graphene/honeycomb Hamiltonian.
`haldane_honeycomb_lattice`	function	`quantum_lattice_models.topological`	Return a finite honeycomb-lattice Haldane-model matrix.
`haldane_honeycomb_lattice_sparse`	function	`quantum_lattice_models.topological`	Return a sparse finite Haldane honeycomb-lattice matrix.
`haldane_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`harper_hofstadter_square_lattice`	function	`quantum_lattice_models.topological`	Return a square-lattice Harper-Hofstadter single-particle Hamiltonian.
`harper_hofstadter_square_lattice_sparse`	function	`quantum_lattice_models.topological`	Return a sparse Harper-Hofstadter square-lattice matrix.
`has_particle_hole_symmetric_spectrum`	function	`quantum_lattice_models.diagnostics`	Return whether a Hermitian spectrum is paired as `E` and `-E`.
`heisenberg_chain`	function	`quantum_lattice_models.spin`	Return the dense anisotropic Heisenberg spin-chain Hamiltonian.
`heisenberg_chain_sector`	function	`quantum_lattice_models.spin`	Build an anisotropic Heisenberg chain in a fixed-magnetization sector.
`heisenberg_chain_sector_sparse`	function	`quantum_lattice_models.spin`	Registered sparse alias for :func:`heisenberg_chain_sector`.
`heisenberg_chain_sparse`	function	`quantum_lattice_models.spin`	Return the sparse anisotropic Heisenberg spin-chain Hamiltonian.
`heisenberg_ladder`	function	`quantum_lattice_models.spin`	Return a dense two-leg Heisenberg ladder with `2 * n_rungs` spins.
`heisenberg_ladder_sector`	function	`quantum_lattice_models.spin`	Build a two-leg Heisenberg ladder in a fixed-magnetization sector.
`heisenberg_ladder_sector_sparse`	function	`quantum_lattice_models.spin`	Registered sparse alias for :func:`heisenberg_ladder_sector`.
`heisenberg_ladder_sparse`	function	`quantum_lattice_models.spin`	Return the sparse two-leg Heisenberg ladder Hamiltonian.
`honeycomb_lattice_index`	function	`quantum_lattice_models.topological`	Return the row-major index for a honeycomb unit-cell sublattice.
`honeycomb_lattice_positions`	function	`quantum_lattice_models.geometry`	Return row-major two-sublattice coordinates for a honeycomb lattice.
`honeycomb_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`import_graphml`	function	`quantum_lattice_models.interchange`	Import a GraphML lattice through the optional NetworkX dependency.
`import_hamiltonian`	function	`quantum_lattice_models.storage`	Import an external NPY or NPZ matrix with explicit portable metadata.
`import_lattice_csv`	function	`quantum_lattice_models.interchange`	Import paired site and bond tables with an optional metadata sidecar.
`import_lattice_xyz`	function	`quantum_lattice_models.adapters`	Import XYZ coordinates without inferring bonds or model semantics.
`import_model_yaml`	function	`quantum_lattice_models.adapters`	Load and validate a model specification from optional YAML.
`inspect_model`	function	`quantum_lattice_models.diagnostics`	Return a construction-free resource and risk report.
`inverse_participation_ratio`	function	`quantum_lattice_models.observables`	Return sum_i \|v_i\|^4 / (sum_i \|v_i\|^2)^2.
`is_hermitian`	function	`quantum_lattice_models.diagnostics`	Return whether a square dense or sparse matrix is Hermitian.
`is_model_alias`	function	`quantum_lattice_models.registry`	Return whether a registered name is a compatibility alias.
`j1_j2_heisenberg_chain`	function	`quantum_lattice_models.spin`	Return a dense frustrated J1-J2 Heisenberg spin-chain Hamiltonian.
`j1_j2_heisenberg_chain_sparse`	function	`quantum_lattice_models.spin`	Return the sparse frustrated J1-J2 Heisenberg spin-chain Hamiltonian.
`kagome_lattice_index`	function	`quantum_lattice_models.tight_binding`	Return the row-major index for a kagome unit-cell sublattice.
`kagome_lattice_positions`	function	`quantum_lattice_models.geometry`	Return row-major three-sublattice coordinates for a kagome lattice.
`kagome_lattice_tight_binding`	function	`quantum_lattice_models.tight_binding`	Return a finite kagome-lattice single-particle tight-binding matrix.
`kagome_lattice_tight_binding_sparse`	function	`quantum_lattice_models.tight_binding`	Return a sparse kagome-lattice tight-binding matrix.
`kagome_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`kitaev_chain_bdg`	function	`quantum_lattice_models.topological`	Return a single-particle Bogoliubov-de Gennes matrix for the Kitaev chain.
`lattice_annotation_data`	function	`quantum_lattice_models.visual_export`	Extract deterministic defect, boundary, interface, and disorder annotations.
`lattice_subgraph`	function	`quantum_lattice_models.transformations`	Return the induced subgraph on selected sites, preserving their order.
`lieb_lattice`	function	`quantum_lattice_models.benchmarks`	Return an open finite Lieb lattice with three orbitals per unit cell.
`lint_model`	function	`quantum_lattice_models.intake`	Return validation errors, warnings, and follow-up checks for a model.
`list_models`	function	`quantum_lattice_models.registry`	Return logical model names filtered by discovery metadata.
`list_presets`	function	`quantum_lattice_models.registry`	Return named presets, optionally restricted to one model.
`load_analysis_result`	function	`quantum_lattice_models.analysis`	Load a JSON or NPZ analysis result.
`load_hamiltonian`	function	`quantum_lattice_models.storage`	Load a Hamiltonian result saved by :func:`save_hamiltonian`.
`load_model`	function	`quantum_lattice_models.specs`	Load and validate a model specification from JSON.
`load_model_plugins`	function	`quantum_lattice_models.registry`	Load third-party registration callbacks from Python entry points.
`load_periodic_lattice`	function	`quantum_lattice_models.periodic`	Public package symbol.
`local_density_of_states`	function	`quantum_lattice_models.observables`	Return Lorentzian-broadened local density of states by site and energy.
`long_range_tight_binding_chain`	function	`quantum_lattice_models.benchmarks`	Return a chain with hopping decaying as inverse distance to `power`.
`longitudinal_field_ising`	function	`quantum_lattice_models.spin`	Return `H = -J sum ZZ - h_x sum X - h_z sum Z`.
`longitudinal_field_ising_sparse`	function	`quantum_lattice_models.spin`	Return the sparse Ising Hamiltonian with transverse and longitudinal fields.
`magnetization_z`	function	`quantum_lattice_models.observables`	Return average Pauli-Z magnetization per site.
`matrix_block_structure`	function	`quantum_lattice_models.visual_export`	Return basis-labeled matrix block boundaries and norms.
`matrix_density`	function	`quantum_lattice_models.diagnostics`	Return the fraction of nonzero matrix entries.
`matrix_storage_bytes`	function	`quantum_lattice_models.diagnostics`	Return bytes used by dense data or a SciPy sparse matrix's core arrays.
`metadata_path`	function	`quantum_lattice_models.storage`	Return the deterministic JSON sidecar path for an NPY matrix.
`migrate_spec_data`	function	`quantum_lattice_models.specs`	Migrate decoded model or lattice data to the current schema.
`mixed_spin_correlation_matrix`	function	`quantum_lattice_models.observables`	Return mixed-axis `<P_i Q_j>` spin correlations.
`model_table`	function	`quantum_lattice_models.registry`	Return registry metadata as dictionaries for docs, CLIs, or notebooks.
`next_nearest_neighbor_ising`	function	`quantum_lattice_models.spin`	Return `H = -J1 sum ZiZi+1 - J2 sum ZiZi+2 - h sum X`.
`next_nearest_neighbor_ising_sparse`	function	`quantum_lattice_models.spin`	Return the sparse next-nearest-neighbor Ising Hamiltonian.
`parameter_sweep`	function	`quantum_lattice_models.advanced`	Evaluate a scalar analysis across one model parameter.
`particle_model_subgraph`	function	`quantum_lattice_models.transformations`	Extract a single-particle model while remapping geometry and interactions.
`particle_model_vacancies`	function	`quantum_lattice_models.transformations`	Remove physical sites from a portable single-particle model.
`quench_dynamics`	function	`quantum_lattice_models.advanced`	Evolve the initial Hamiltonian's ground state under a final Hamiltonian.
`random_field_heisenberg_chain`	function	`quantum_lattice_models.benchmarks`	Return a Heisenberg chain with reproducible random longitudinal fields.
`reciprocal_space_data`	function	`quantum_lattice_models.advanced`	Return primitive reciprocal vectors and a first-zone polygon.
`reduced_density_matrix`	function	`quantum_lattice_models.observables`	Return the normalized reduced density matrix for selected spin sites.
`reduced_expectation`	function	`quantum_lattice_models.reduced`	Evaluate a full- or reduced-basis operator on a reduced state.
`reduced_operator`	function	`quantum_lattice_models.reduced`	Project a full-basis operator into an explicit reduced basis.
`register_model`	function	`quantum_lattice_models.registry`	Register a model builder for discovery by notebooks, docs, and the CLI.
`relabel_lattice`	function	`quantum_lattice_models.transformations`	Return a lattice whose new site order is given by old site indices.
`remove_lattice_bonds`	function	`quantum_lattice_models.transformations`	Remove every bond matching a source-target pair.
`remove_lattice_sites`	function	`quantum_lattice_models.transformations`	Remove vacancy sites and all incident bonds.
`repeat_unit_cell`	function	`quantum_lattice_models.transformations`	Expand a periodic unit cell into a finite portable lattice.
`rice_mele_model`	function	`quantum_lattice_models.tight_binding`	Return the single-particle Rice-Mele chain matrix.
`rice_mele_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`save_analysis_result`	function	`quantum_lattice_models.analysis`	Save an analysis result as readable JSON or self-contained NPZ.
`save_hamiltonian`	function	`quantum_lattice_models.storage`	Save a Hamiltonian result as NPY plus JSON or as self-contained NPZ.
`sawtooth_chain`	function	`quantum_lattice_models.benchmarks`	Return a sawtooth/delta chain with two orbitals per cell.
`sector_compatibility`	function	`quantum_lattice_models.conserved`	Return whether a Hamiltonian preserves a proposed sector quantity.
`single_particle_occupations`	function	`quantum_lattice_models.observables`	Return normalized site/orbital occupations for a single-particle state.
`site_magnetization_z`	function	`quantum_lattice_models.observables`	Return the site-resolved expectations `<Z_i>`.
`solve_eigenpairs`	function	`quantum_lattice_models.advanced`	Solve eigenpairs with explicit sparse-to-dense safeguards and residuals.
`spectrum_result`	function	`quantum_lattice_models.analysis`	Return a portable complete-spectrum result.
`spin_correlation_matrix`	function	`quantum_lattice_models.observables`	Return all `<P_i P_j>` correlations for one Pauli axis.
`spin_observables_result`	function	`quantum_lattice_models.analysis`	Return site magnetization and same-axis correlation records.
`spin_texture_plot_data`	function	`quantum_lattice_models.visual_export`	Return site coordinates and local spin expectation arrows.
`square_lattice_index`	function	`quantum_lattice_models.tight_binding`	Return the row-major site index for a square/rectangular lattice.
`square_lattice_positions`	function	`quantum_lattice_models.geometry`	Return row-major `(x, y)` coordinates for a square lattice.
`square_lattice_tight_binding`	function	`quantum_lattice_models.tight_binding`	Return a single-particle tight-binding matrix on a rectangular square lattice.
`square_lattice_tight_binding_sparse`	function	`quantum_lattice_models.tight_binding`	Return a sparse rectangular square-lattice tight-binding matrix.
`square_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`ssh_model`	function	`quantum_lattice_models.tight_binding`	Return the single-particle Su-Schrieffer-Heeger tight-binding matrix.
`ssh_unit_cell`	function	`quantum_lattice_models.periodic`	Public package symbol.
`standard_momentum_path`	function	`quantum_lattice_models.periodic`	Return a conventional path for supported one- and two-dimensional cells.
`static_spin_structure_factor`	function	`quantum_lattice_models.observables`	Return `S(q) = N^-1 sum_ij exp[iq(r_i-r_j)] C_ij`.
`substitute_particle_bonds`	function	`quantum_lattice_models.transformations`	Replace selected directed hopping amplitudes in a portable particle model.
`supports_sparse`	function	`quantum_lattice_models.registry`	Return whether a registered model can construct a sparse Hamiltonian.
`susceptibility`	function	`quantum_lattice_models.advanced`	Estimate zero-temperature response to an explicit conjugate field.
`thermal_observables`	function	`quantum_lattice_models.advanced`	Return canonical small-system thermodynamics with stable shifted weights.
`tight_binding_chain`	function	`quantum_lattice_models.tight_binding`	Return a generic one-dimensional single-particle tight-binding matrix.
`tight_binding_chain_sparse`	function	`quantum_lattice_models.tight_binding`	Return a sparse 1D single-particle tight-binding matrix.
`to_netket_graph`	function	`quantum_lattice_models.adapters`	Translate finite portable geometry to a NetKet graph.
`to_networkx`	function	`quantum_lattice_models.interchange`	Return a NetworkX `MultiDiGraph` preserving lattice attributes.
`to_openfermion`	function	`quantum_lattice_models.adapters`	Translate portable fermion interaction records to `FermionOperator`.
`to_qiskit_sparse_pauli`	function	`quantum_lattice_models.adapters`	Translate portable spin terms to Qiskit's `SparsePauliOp`.
`to_quspin_hamiltonian`	function	`quantum_lattice_models.adapters`	Translate portable spin Pauli terms to a QuSpin Hamiltonian.
`to_qutip_qobj`	function	`quantum_lattice_models.adapters`	Construct a QuTiP `Qobj` while retaining portable model metadata.
`to_styled_networkx`	function	`quantum_lattice_models.visual_export`	Export a styled physical interaction graph with deterministic attributes.
`topology_result`	function	`quantum_lattice_models.analysis`	Return a portable scalar topological-invariant result.
`total_magnetization_z`	function	`quantum_lattice_models.observables`	Return the total Pauli-Z expectation `sum_i <Z_i>`.
`total_spin_squared`	function	`quantum_lattice_models.observables`	Return `<S^2>` for spin-1/2 sites with `S=Σσ/2`.
`transverse_field_ising`	function	`quantum_lattice_models.spin`	Return `H = -J sum ZZ - h sum X`.
`transverse_field_ising_sparse`	function	`quantum_lattice_models.spin`	Return the sparse transverse-field Ising Hamiltonian.
`triangular_lattice_positions`	function	`quantum_lattice_models.geometry`	Return row-major `(x, y)` coordinates for a triangular lattice.
`triangular_lattice_tight_binding`	function	`quantum_lattice_models.tight_binding`	Return a single-particle tight-binding matrix on a triangular lattice.
`triangular_lattice_tight_binding_sparse`	function	`quantum_lattice_models.tight_binding`	Return a sparse triangular-lattice tight-binding matrix.
`two_parameter_sweep`	function	`quantum_lattice_models.advanced`	Evaluate a scalar analysis on a two-parameter grid.
`unregister_model`	function	`quantum_lattice_models.registry`	Remove and return a registered model.
`wilson_loop`	function	`quantum_lattice_models.advanced`	Return occupied-subspace Wilson-loop eigenphases along reciprocal vector one.
`wilson_loop_winding`	function	`quantum_lattice_models.advanced`	Estimate occupied-subspace Wilson-loop determinant winding.
`winding_number`	function	`quantum_lattice_models.topology`	Return the winding of a two-band chiral Hamiltonian's off-diagonal term.
`winding_number_result`	function	`quantum_lattice_models.topology`	Return the chiral winding number as a portable analysis result.
`with_boundary_conditions`	function	`quantum_lattice_models.transformations`	Return a lattice with replaced boundary-condition metadata.
`xxz_chain`	function	`quantum_lattice_models.spin`	Return the dense XXZ spin-chain Hamiltonian.
`xxz_chain_sector`	function	`quantum_lattice_models.spin`	Build an XXZ chain in a fixed total Pauli-Z sector.
`xxz_chain_sector_sparse`	function	`quantum_lattice_models.spin`	Registered sparse alias for :func:`xxz_chain_sector`.
`xxz_chain_sparse`	function	`quantum_lattice_models.spin`	Return the sparse XXZ spin-chain Hamiltonian.
`xy_chain`	function	`quantum_lattice_models.spin`	Return the dense anisotropic XY spin-chain Hamiltonian.
`xy_chain_sparse`	function	`quantum_lattice_models.spin`	Return the sparse anisotropic XY spin-chain Hamiltonian.
`xyz_chain`	function	`quantum_lattice_models.benchmarks`	Return an XYZ spin chain.
`zak_phase`	function	`quantum_lattice_models.topology`	Return the discretized Zak phase for one isolated one-dimensional band.
`zak_phase_result`	function	`quantum_lattice_models.topology`	Return the Zak phase as a portable analysis result.

Back to the model reference