Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.37 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.37 KB
Raw

Model Hamiltonian

This utility generates 1- and 2-electron integrals corresponding to various model Hamiltonians. The basic input is some indication of connectivity, either explicitly or as a lattice. One then specifies the Hamiltonian of interest. The output are 1- and 2-electron integrals in a format convenient for use in other (external) software packages.

Installation

python3 -m pip install .

Subversions of the ModelHamiltonian

To install a specific subversion of the ModelHamiltonian, you can use the following command:

  • For the GPT subversion:
python3 -m pip install .[gpt]
  • For the GUI subversion:
python3 -m pip install .[gui]
  • For the TOML subversion:
python3 -m pip install .[toml]

Coding Guidelines

We document our default QC-Devs guidelines in the .github repository. We particularly suggest you review:

We also recommend installing pre-commit hooks. That ensure certain basic coding style issues can be detected and fixed before submitting the pull request. To set up these hooks, install https://pre-commit.com/ (e.g. using pip install --user pre-commit) and run pre-commit install.