Skip to main content

Quantum cluster methods for the physics of strongly correlated systems.

Project description

Pyqcm

Pyqcm is a Python/C++ library that implements a few quantum cluster methods with an exact diagonalization impurity solver. Quantum cluster methods are used in the study of strongly correlated electrons to provide an approximate solution to Hubbard-like models. The methods covered by this library are Cluster Perturbation Theory (CPT), the Variational Cluster Approach (VCA) and Cellular (or Cluster) Dynamical Mean Field Theory (CDMFT). The impurity solver (the technique used to compute the cluster's interacting Green function) is exact diagonalization from sparse matrices, using the Lanczos algorithm and variants thereof. The core library is written in C++ for performance, but the interface is in Python, for ease of use and inter-operability with the numerical Python ecosystem. The library is distributed under the GPL license.

A comprehensive paper describing the different methods and version 2.1 of the software is available on arXiv repository.

The source code is hosted on GitHub: https://github.com/pyqcm-project/pyqcm.

Installation

Pyqcm depends on a BLAS-LAPACK implementation available on your system (such as OpenBLAS) and the Eigen template librairie. These dependencies can be installed using the apt package manager on Debian system as (Ubuntu):

sudo apt install libopenblas-dev libeigen3-dev

Once installed, Pyqcm can be installed using the pip package manager as:

pip install pyqcm

Note only sources distribution are available and compilation is carried on the target system. This is for enabling the most appropriate optimizations at building time for faster running time. By default, a build-capability build of Pyqcm is carried. Pyqcm is compatible (i.e. have been tested) on various Linux distribution on x86 computers (Intel and AMD) and Apple ARM processors. Finely tuned installation can be acheived by specifiyng the environment variable CMAKE_ARGS before to install Pyqcm via pip (see the section Advanced installation on the documentation).

Examples and documentation

Pyqcm documentation is hosted on ReadTheDocs and is available at https://qcm-wed.readthedocs.io/.

EXAMPLES can be found in the notebooks/ folder, either in plain python files (*.py) or in the form of Jupyter notebooks (*.ipynb).

Contact

Questions and comments can be addressed to:

david.senechal@usherbrooke.ca

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyqcm-2.26.7.tar.gz (1.2 MB view details)

Uploaded Source

File details

Details for the file pyqcm-2.26.7.tar.gz.

File metadata

  • Download URL: pyqcm-2.26.7.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for pyqcm-2.26.7.tar.gz
Algorithm Hash digest
SHA256 d6b0fa95a20358bd91067ce6e2b59e281100a0228ddf63a6ac17e2a9f0817b31
MD5 0ff552c345f8e1a75c0991b919f152d0
BLAKE2b-256 0016f49ea8240555f3fb0a956384c5f1e157a4ef66c724b0b82eacb05454a37d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page