This is a copy of the Agda Universal Algebra Library which depends the Standard Library of the Agda proof assistant language. It is currently under active reconstruction, and should be regarded as α software.
The previous version of the library (which was called UALib and relied more heavily on the Type Topology library of Martín Escardó) is no longer maintained, but is still available at the following urls.
- UALib source code repository: https://gitlab.com/ualib/ualib.gitlab.io
- UALib documentation: https://ualib.gitlab.io
This repository contains the source code, as well as the files used to generate the documentation, of the Agda Universal Algebra Library.
Agda was used to generate html pages for each module. These pages are now served at
The library has been developed and tested with Agda version 2.6.2 and the Agda Standard Library version 1.7. (It may work with more recent versions, but there are no guarantees.)
If you don't have Agda, follow the official Agda installation instructions.
For reference, the following is a list of commands that should correctly install Agda version 2.6.2 on a Linux machine. These commands were tested on a Ubuntu 22.04 machine. Please submit a new issue or merge request if these commands don't work for you.
cabal update
git clone git@github.com:agda/agda.git
cd agda
git checkout release-2.6.2
cabal install Agda-2.6.2 --program-suffix=-2.6.2 # (takes a very long time)
cd ~/.cabal/bin/
touch ~/.emacs
cp ~/.emacs ~/.emacs.backup
./agda-mode-2.6.2 setup
./agda-mode-2.6.2 compile
mkdir -p ~/bin
cp ~/.emacs ~/bin
cp ~/.emacs.backup ~/.emacs
cd ~/bin
echo '#!/bin/bash' > agdamacs
echo 'PATH=~/.cabal/bin:$PATH emacs --no-init-file --load ~/bin/.emacs $@' >> agdamacs
chmod +x agdamacs
echo 'export PATH=~/bin:~/.cabal/bin:$PATH' >> ~/.profile
Now invoking the command agdamacs will launch emacs with Agda 2.6.2 and agda-mode installed.)
For more details, see also: INSTALL_AGDA.md
If you wish to contribute to this repository, the best way is to use the standard fork-clone-pull-request workflow.
The agda-algebras library is developed and maintained by the ualib/agda-algebras development team.
We thank Andreas Abel, Jeremy Avigad, Andrej Bauer, Clifford Bergman, Venanzio Capretta, Martín Escardó, Ralph Freese, Hyeyoung Shin, and Siva Somayyajula for helpful discussions, corrections, advice, inspiration and encouragement.
Most of the mathematical results formalized in the agda-algebras are well known. Regarding the source code in the agda-algebras library, this is mainly due to the contributors listed above.
The following Agda documentation and tutorials helped inform and improve the agda-algebras library, especially the first one in the list.
- Escardo, Introduction to Univalent Foundations of Mathematics with Agda
- Wadler, Programming Languages Foundations in Agda
- Bove and Dybjer, Dependent Types at Work
- Gunther, Gadea, Pagano, Formalization of Universal Algebra in Agda
- Norell and Chapman, Dependently Typed Programming in Agda
Finally, the official Agda Wiki, Agda User's Manual, Agda Language Reference, and the (open source) Agda Standard Library source code are also quite useful.
To cite the agda-algebras software library in a publication or on a web page, please use the following BibTeX entry:
@misc{ualib_v2.0.1,
author = {De{M}eo, William and Carette, Jacques},
title = {{T}he {A}gda {U}niversal {A}lgebra {L}ibrary (agda-algebras)},
year = 2021,
note = {{D}ocumentation available at https://ualib.org},
version = {2.0.1},
doi = {10.5281/zenodo.5765793},
howpublished = {{G}it{H}ub.com},
note = {{V}er.~2.0.1; source code: \href{https://zenodo.org/record/5765793/files/ualib/agda-algebras-v.2.0.1.zip?download=1}{agda-algebras-v.2.0.1.zip}, {G}it{H}ub repo: \href{https://github.com/ualib/agda-algebras}{github.com/ualib/agda-algebras}},
} To cite the formalization of Birkhoff's HSP Theorem, please use the following BibTeX entry:
@article{DeMeo:2021,
author = {De{M}eo, William and Carette, Jacques},
title = {A {M}achine-checked {P}roof of {B}irkhoff's {V}ariety {T}heorem
in {M}artin-{L}\"of {T}ype {T}heory},
journal = {CoRR},
volume = {abs/2101.10166},
year = {2021},
eprint = {2101.2101.10166},
archivePrefix = {arXiv},
primaryClass = {cs.LO},
url = {https://arxiv.org/abs/2101.10166},
note = {Source code: \href{https://github.com/ualib/agda-algebras/blob/master/src/Demos/HSP.lagda}{https://github.com/ualib/agda-algebras/blob/master/src/Demos/HSP.lagda}}
}If you're looking for the latest (setoid-based) formalization of Brkhoff's Theorem, see the Proof of the HSP Theorem in the html documentation, or the source code of the [Setoid.Varieties.HSP][] module in the file [Setoid/Varieties/HSP.lagda][] in the agda-algebras GitHub repository.
The Agda Universal
Algebra Library by William DeMeo and the Agda Algebras Development Team is licensed under a Creative Commons
Attribution-ShareAlike 4.0 International License.
Based on a work at
https://gitlab.com/ualib/ualib.gitlab.io.
