User Guide#

The Quickstart builds a VMC script from five components. Each page of this guide covers one of them: what the library provides, and how to build your own.

Component

Page

Main objects

Lattice

Lattices

square, Lattice.create, lattice.bonds

Hamiltonian

Hamiltonians

Sz, Splus, Cup_dag, heisenberg_hamiltonian

Initial configurations

Initial Configurations

SpinState, FermionState, init_config_fixed_magn

Wavefunction

Wavefunctions

WaveFunction, SpinViT, FermionicTransformer

Monte Carlo move

Monte Carlo Sampling

sample, BondExchange, SpinFlip

Optimization step

Optimization

SR, MARCH, train

Each code cell on these pages can be read on its own: it defines every name it uses, except those of the quickstart scripts, such as lattice, key, N_mc, state and wf, which refer to the objects defined there.