Qlua Documentation
How to build Qlua, how to learn it, and what every name in it does.
The documentation comes in three parts, meant to be read in the order below.
Installation describes the build system and what it needs from the
machine. The tutorials teach the language by example, each one a
short program that runs. The reference manual is the other half of
the tutorials: it lists every function and method the interpreter answers to, what it
takes and what it gives back.
If you are new to Qlua, the tutorials are the place to start — they assume Lua and
lattice QCD, not Qlua. If you are looking for the exact signature of something you
already use, go to the manual.
| Document | What it covers |
|---|
| Installation |
Building Qlua and the USQCD stack it needs with the build3 system:
what must already be on the machine, how a target is described, and how
the build is run. |
| Tutorials |
Qlua by example, from a first program through lattices and fields, the
file formats, and the Level III solvers to the gradient flow. |
| Reference Manual |
Every user-accessible function of the interpreter, organized by the data
type it belongs to and, for the Level III solvers, by solver. |
The tutorials and the manual describe qlua/2026.10d and
later. Against an older build some of what they say is simply wrong: several methods
they describe do not exist in earlier versions, and calling a name a Qlua object does
not know aborts the job rather than returning nil.
|
