https://github.com/chrisculver/WickContractions

https://github.com/chrisculver/WickContractions

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/chrisculver/WickContractions
• Owner: chrisculver
• License: mit
• Created: 2021-03-24T14:40:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-29T14:46:43.000Z (about 1 year ago)
• Last Synced: 2024-07-04T00:56:51.775Z (3 months ago)
• Language: Python
• Size: 832 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Readme

This code computes the wick contractions for LQCD operators that contain

quark fields.  The final result is a list of diagrams that are to be 

evaluated numerically to obtain the correlation function.

## Installation

Install locally in a conda environment with `pip install -e .`

## Examples

For the charged pion check out PionCorrelator.ipynb.

## Tests and Code Coverage

To run all the tests type

    coverage run -m pytest

Then

    coverage report -m  

To make this work I have added an empty conftest.py to WickContractions, to trick pytest.

## Docs

CURRENTLY BROKEN

To create the docs type 'make html' or 'make latex' in the top directory.

If you make latex then go into docs/latex and type make again to generate the pdf.

If you make html then run firefox /docs/html/index.html.  This is the version

that will be uploaded to ReadTheDocs.