====== GfTool

+---------+-----------------------+------------------+--------------+ | master ||build-status-master| ||codecov-master| ||rtd-master| | +---------+-----------------------+------------------+--------------+ | develop ||build-status-develop| ||codecov-develop| ||rtd-develop| | +---------+-----------------------+------------------+--------------+

|pypi| |conda-forge| |DOI|

Collection of commonly used Green's functions and utilities. The main purpose of this module is to have a tested and thus reliable basis to do numerics. It happened to me too often, that I just made a mistake copying the Green's function and was then wondering what was wrong with my algorithm. For example, a selection of lattice Green's functions or rather the corresponding DOSs:

.. image:: https://gftools.readthedocs.io/en/develop/_images/dos_gallary.png :width: 800 :alt: Selection of DOSs

Also have a look at the tutorial_ to get an idea.

The main use case of GfTool was DMFT and its real space generalization, in particular using CT-QMC algorithms.

Installation

The package is available on PyPI_:

.. code-block:: console

$ pip install gftool

For conda_ users, GfTool is also available on conda-forge_

.. code-block:: console

$ conda install -c conda-forge gftool

Alternatively, it can be installed via GitHub. You can install it using

.. code-block:: console

$ pip install https://github.com/DerWeh/gftools/archive/VERSION.zip

where VERSION can be a release (e.g. 0.5.1) or a branch (e.g. develop). (As always, it is not advised to install it into your system Python, consider using pipenv, venv, conda, pyenv, or similar tools.) Of course, you can also clone or fork the project.

If you clone the project, you can locally build the documentation:

.. code-block:: console

$ pip install -r requirements-doc.txt $ python setup.py build_sphinx

Documentation

The documentation and API is on ReadTheDocs. The documentation of specific branches can also be accessed: master doc, develop doc. There is also a GitHub page: documentation.

Currently, the package's main content is

gftool

• Collection of non-interacting Green's functions and spectral functions, see also the lattice submodule.
• Utility functions like Matsubara frequencies and Fermi functions.
• Reliable calculation of particle numbers via Matsubara sums.

cpa/beb

• Single site approximation to disorder.
• Diagonal disorder only (CPA) and diagonal and off-diagonal (BEB).
• Average local Green's function and component Green's functions.

fourier

• Fourier transforms from Matsubara frequencies to imaginary time and back, including the handling of high-frequencies moments (especially important for transforms from Matsubara to imaginary time).
• Laplace transform from real times to complex frequencies.

matrix

• Helper for Green's functions in matrix form.

pade

• Analytic continuation via the Padé algorithm.

  • Calculates a rational polynomial as interpolation of the data points.
  • Note: the module is out-dated, so it's not well documented at a bit awkward to use. Consider using polepade instead.

polepade

• Analytic continuation via a pole-based variant of the Padé algorithm.

  • Based on explicit calculation of the pole in a least-squares sense.
  • Allows including uncertainties as weights.

siam

• Basic Green's functions for the non-interacting Single Impurity Anderson model.

.. |build-status-master| image:: https://github.com/DerWeh/gftools/actions/workflows/ci.yml/badge.svg?branch=master :target: https://github.com/DerWeh/gftools/actions/workflows/ci.yml?query=branch%3Amaster :alt: Build status master .. |codecov-master| image:: https://codecov.io/gh/DerWeh/gftools/branch/master/graph/badge.svg :target: https://app.codecov.io/gh/DerWeh/gftools/branch/master :alt: Coverage master .. |rtd-master| image:: https://readthedocs.org/projects/gftools/badge/?version=master :target: https://gftools.readthedocs.io/en/master/?badge=master :alt: Documentation Status master .. |build-status-develop| image:: https://github.com/DerWeh/gftools/actions/workflows/ci.yml/badge.svg?branch=develop :target: https://github.com/DerWeh/gftools/actions/workflows/ci.yml?query=branch%3Adevelop :alt: Build status develop .. |codecov-develop| image:: https://codecov.io/gh/DerWeh/gftools/branch/develop/graph/badge.svg :target: https://app.codecov.io/gh/DerWeh/gftools/branch/develop :alt: Coverage develop .. |rtd-develop| image:: https://readthedocs.org/projects/gftools/badge/?version=develop :target: https://gftools.readthedocs.io/en/develop/?badge=develop :alt: Documentation Status .. |pypi| image:: https://badge.fury.io/py/gftool.svg :target: https://badge.fury.io/py/gftool :alt: PyPI release .. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/gftool.svg :target: https://anaconda.org/conda-forge/gftool :alt: conda-forge release .. |DOI| image:: https://zenodo.org/badge/115784231.svg :target: https://zenodo.org/badge/latestdoi/115784231 :alt: DOI .. _documentation: https://derweh.github.io/gftools/ .. _master doc: https://gftools.readthedocs.io/en/master/ .. _develop doc: https://gftools.readthedocs.io/en/develop/ .. _ReadTheDocs: https://gftools.readthedocs.io/en/latest/ .. _tutorial: https://gftools.readthedocs.io/en/develop/tutorial.html .. _PyPi: https://pypi.org/project/gftool/ .. _pipenv: https://pipenv.kennethreitz.org/en/latest/#install-pipenv-today .. _venv: https://docs.python.org/3/library/venv.html .. _conda: https://docs.conda.io/en/latest/ .. _conda-forge: https://anaconda.org/conda-forge/gftool .. _pyenv: https://github.com/pyenv/pyenv