Added documentation for most modules

Only Spinors and Dirac are missing.
This commit is contained in:
Alberto Ramos 2023-12-13 14:45:45 +01:00
parent b4a269f9af
commit 651891f95a
16 changed files with 298 additions and 19 deletions

59
docs/src/ym.md Normal file
View file

@ -0,0 +1,59 @@
# Simulating Yang-Mills on the lattice
```@docs
GaugeParm
YMworkspace
ztwist
```
## Gauge actions and forces
Routines to compute the gauge action.
```@docs
gauge_action
```
Routines to compute the force derived from gauge actions.
```@docs
force_gauge
```
### Force field refresh
Algebra fields with **natural indexing** can be randomized.
```@docs
randomize!
```
## Basic observables
Some basic observable.
```@docs
plaquette
```
## HMC simulations
### Integrating the EOM
```@docs
IntrScheme
leapfrog
omf2
omf4
MD!
```
### HMC algorithm
```@docs
hamiltonian
HMC!
```