Julia native Lattice QCD code with dynamical fermions in 4 dimension.
Author akio-tomiya
19 Stars
Updated Last
2 Years Ago
Started In
December 2020

LatticeQCD.jl (ver. 0.5)

Build Status Coverage Coverage


This code enabales you to perform lattice QCD calculations! Native Julia code for Lattice QCD.


You can start it in Google Colab

Quick start

You can start lattice QCD in 5 steps!

1.Download a Julia binary from Set a path to the binary of Julia.

2.In Julia REPL, push "]" key to enter the package mode and type


and "return" key. Press "backspace" key ( "delete" key for mac) to exit the package mode.

(All dependence will be solved automatically)

3.Include the package with

using LatticeQCD

4.Make a parameter file with wizard,


Choose parameters as you want!

5.Start simulation with created your parameter file!


You'll get results!

Of cource, you can write/modify a parameter file by yourself.

Enjoy life with lattice QCD.

To see our demonstration above, execute,

using Plots
using LatticeQCD 

it takes time before showing up the window.

What is supported?

We support 4 dimensional euclidean spacetime and following things:

  • Gauge field
    • Optimized SU(2), SU(3)
    • General SU(N)
    • General gauge action = plaquette + rect + etc action
  • Fermions
    • Wilson/Wilson-clover (2 flavors)
    • Staggered fermion (1-8 tastes ~ flavors)
  • Configuration generation algorithms
    • Cold/Hot start for SU(N). One instanton configuration for SU(2)
    • Heatbath for SU(N) & overrelaxation for a general gauge action
    • Quenched HMC with SU(N) for a general gauge action
    • HMC (2 flavor Wilson/Clover) with SU(N) with a general gauge action
    • HMC (4 taste staggered fermions) with SU(N) with a general gauge action
    • RHMC (any flavor staggered) with SU(N) for a general gauge action*
    • SU(N) stout smeared dynamical fermions (experimental)
    • Fermion integrated HMC with a general gauge action
    • Self-learning Monte-Carlo with a general action (ref. this paper )
    • Self-learning HMC with plaquette action
  • Measurements
    • Plaquette
    • Polyakov loop
    • Chiral condensates (Wilson, Wilson-Clover, staggered)
    • Momentum projected pion correlator (Wilson& Wilson-Clover fermion, staggered will be supported)
    • Topological charge(plaquette and clover definition)
    • Load & measurement mode (load and measure all configurations in a directory)
  • Smearing
    • APE, stout (This will be public)
    • Gradient flow for a genelic action (Not well tested)
  • I/O for configurations
    • ILDG format
    • JLD format (default binary file for Julia, one of HDF5)

*If you specified other than Nf=4, 8 with the staggered fermion HMC, RHMC is automatically used. For a machine with the apple silicon, Nf=1-8 is avalable.

Many of smearing and improved fermion actions and parallelazation have not supported yet.

USAGE/User interface

We support following two user interfaces

  1. Julia REPL interface (For beginners, just after the lattice QCD textbook)
  2. Genral interface (Experience with another code, for batch job, customised purpose)

Usage 1 was already explained.

For Usage 2, in Julia REPL, push "]" key to enter the package mode and type


Then, LatticeQCD.jl is installed on your machine.

The "PARAMETER_FILE" can be created through the wizard. To use the wizard on the shell, you write the following code (& save as wizard.jl):

using LatticeQCD

Then, you can run the wizard:

julia wizard.jl

You write the following code (& save as run.jl):

using LatticeQCD

Then, you can execute like

julia run.jl PARAMETER_FILE

then, you get results though standard I/O.

Purpose of the code

We develop this code to achive following things:

  1. Good portability (If one has Julia, this code is runnable. All dependences are under control.)
  2. Easy to start/ pedagogical (start in 10 minutes)
  3. Suite (configuration generation with and without fermions, and measurements)
  4. Easy to modify (Good for prototyping)
  5. Compatitive speed with Fortran 90 codes

This is the first open source Julia code for lattice QCD. High performance is out of our scope.

How has it been tested?

We compared results to following papers/codes


We refer "Lattice Tool Kit" written in Fortran 90.