Supervillain is a python package for studying the Villain model.
Navigate to the cloned repo and try
pip install . # for development use pip install -e .
./test/end-to-end.py
If pip installation succeeds so too should the example script, which by default samples the (φ, n) formulation of the model on a small lattice.
supervillain has documentation built with sphinx. To build the documentation once you
sphinx-build . _build
and then can open _build/index.html in a browser.
If you are developing you can replace sphinx-build with sphinx-autobuild to get live updates to the documentation as you go.