Welcome to gsum’s documentation!

gsum logo BUQEYE logo

The gsum package provides convenient classes that allow one to analyze the convergence pattern of Effective Field Theory (EFT) observables. Specifically, this is a conjugacy-based implementation of the statistical model developed in this paper. Although the package is fully functional, we are still working on filling in all of the documentation. Examples of how it was used to generate results can be found in the documentation. The notebooks used in the documentation can be found in docs/notebooks.


The current working branch can be installed via

$ pip install git+https://github.com/buqeye/gsum

Additionally, one can clone the repository and install using

$ git clone https://github.com/buqeye/gsum.git
$ cd gsum
$ pip install .

This will install the package as is, but if you want to make edits to the code for testing you can exchange the last line with pip install -e ., which will allow you to edit the package without reinstalling.

For some Mac users, the build might fail when using the pip install . method. This may be due to the removal of the usr/include directory from new MacOS versions. Running the following command will fix this problem:

$ open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg

Soon, an up-to-date version of this package will be added to pip, for an easier installation process.


gsum is compatible with python 3, but has not been tested with python 2. See the requirements.txt for the full list of dependencies.

Citing gsum

If you have found this package helpful, please cite our paper Melendez et al. (2019), “Quantifying Correlated Truncation Errors in Effective Field Theory” arXiv:1904.10581.


To report an issue please use the issue tracker.


MIT License.

Indices and tables