Welcome to jackknife’s documentation!

This project implements a general interface for jackknife resampling of one or more, potentially high-dimensional observables. This is extended with problem-specifiy modules and scripts. So far, they only exist for jackknifing DGA self-energies and DMFT susceptibilites calculated with ADGA. If you want to do exactly that, check out the user documentation. If you are interested in the implementation details take a look at the source code documentation. If you want to know how to build the documentation go to the end of the page.

User Documentation

Source code documentation

Building the documentation

The documentation you are currently reading including the user and source code documentation is built with Sphinx. It uses Python’s docstrings and reStructuredText. To build it on your local machine you need to install Sphinx (e.g. with conda) and execute the following commands:

cd .../jackknife/doc
make html

The generated HTML files can be found in .../jackknife/doc/build/html/. The main page you are currently looking at is called index.html.