Skip to content

Commit 1a6a7b2

Browse files
committed
Adds initial README and gitignore
1 parent e9c14ea commit 1a6a7b2

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

Diff for: .gitignore

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Prerequisites
2+
*.d
3+
4+
# Compiled Object files
5+
*.slo
6+
*.lo
7+
*.o
8+
*.obj
9+
10+
# Precompiled Headers
11+
*.gch
12+
*.pch
13+
14+
# Compiled Dynamic libraries
15+
*.so
16+
*.dylib
17+
*.dll
18+
19+
# Fortran module files
20+
*.mod
21+
*.smod
22+
23+
# Compiled Static libraries
24+
*.lai
25+
*.la
26+
*.a
27+
*.lib
28+
29+
# Executables
30+
*.exe
31+
*.out
32+
*.app
33+
34+
# bin directory
35+
bin/*
36+
37+
# Emacs backup files
38+
*~
39+
40+
# PYC files
41+
*.pyc
42+
43+
# Paclet files
44+
*.paclet

Diff for: README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
LattLib
2+
=======
3+
Freely usable reference code for prototyping lattice field theory calculations and analysis. All code contained in this repository is covered by the CC0 license, allowing one to freely copy, modify, or distribute anything contained herein, including for commerical purposes. Attribution not required.
4+
5+
Scope of the project
6+
--------------------
7+
This repository provides ...
8+
9+
* A set of Mathematica tools for simple analysis and plotting (`mathlib/`, also available in [paclet form](https://scripts.mit.edu/~gurtej/mma_paclets/qcdlib.paclet)).
10+
* A set of Python tools for simple analysis and plotting (`pylib/`).
11+
* Several libraries with useful functions for MCMC sampling and observable measurements in particular theories (`gauge_theory/`, `scalar_field/`, ...).
12+
* A set of executable Python scripts that expose simulation and measurement functions for various theories (`pybin/`).
13+
14+
Non-scope of the project
15+
------------------------
16+
Code in this repository is intended to serve as a basis for simple prototyping and explorations in low-dimensional theories. Implementations are generally *not optimized, parallelized, or distributed*.
17+
18+
This code is also provided as-is, without guarantees of any kind. Use at your own risk.
19+
20+
Contributions
21+
-------------
22+
This project is not actively being developed, however contributions in the form of pull requests for bug fixes or clean-ups are welcome.
23+
24+
Many thanks to the following folks who have been willing test subjects, have reported bugs, and/or have contributed code!
25+
26+
* Michael S. Albergo ([malbergo](https://github.com/malbergo))
27+
* Artur Avkhadiev ([avkhadiev](https://github.com/avkhadiev))
28+
* Denis Boyda ([boydad](https://github.com/boydad))
29+
* Anthony Grebe ([agrebe](https://github.com/agrebe))
30+
* Daniel C. Hackett ([dchackett](https://github.com/dchackett))
31+
* Michael L. Wagman ([mlwagman](https://github.com/mlwagman))

0 commit comments

Comments
 (0)