Skip to main content

Package to run tight-binding mean field hubbard calculations

Project description

PyPI version DOI

tb-mean-field-hubbard

Python library to perform tight-binding mean field Hubbard calculations on the conjugated π-networks of organic systems. Only carbon atoms are supported and each atom is modelled by a single pz orbital hosting a single electron.

The modelled Hamiltonian is the following:

where c, c and n are respectively the creation, annihiliation and number operators, t is the hopping integral and U denotes the on-site Coulomb repulsion.

System requirements

Python 3 (tested with 3.6 - 3.9) environment is required with the following libraries (parenthesis indicate tested versions; but the library should work with all recent versions):

  • Standard python libraries: numpy (1.17.2), scipy (1.3.1), matplotlib (3.2.1)
  • Atomistic simulation environment: ase (3.18.1)
  • Python Tight Binding: pythtb (1.7.2)

Installation

Option 1) Install the library and dependencies hosted on PyPI:

pip install tb-mean-field-hubbard

Option 2) Manual installation, such that you have direct access to the code and the notebook:

git clone https://github.com/eimrek/tb-mean-field-hubbard.git
cd tb-mean-field-hubbard
pip install -e .

On a normal desktop computer, installation of the python dependencies can take some minutes, while the tb-mean-field-hubbard should install in seconds.

Example usage

Example jupyter notebook example.ipynb is provided that performs the calculation for the Clar's goblet molecule. The geometry is read from a xyz file. The whole notebook should run in a matter of seconds on a normal desktop computer. The following image demonstrates a selection of the output for the calculation for parameters t=2.7 and U=3.0 (both in electronvolts).

In addition to the structure of Clar's goblet, the geom/ folder contains input geometries for triangulene, 4- and 5-rhombene, and several other systems.

Project details


Download files

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

Source Distribution

tb-mean-field-hubbard-1.4.0.tar.gz (11.6 kB view details)

Uploaded Source

File details

Details for the file tb-mean-field-hubbard-1.4.0.tar.gz.

File metadata

  • Download URL: tb-mean-field-hubbard-1.4.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for tb-mean-field-hubbard-1.4.0.tar.gz
Algorithm Hash digest
SHA256 7a47f10ea3e133b209880e8c92949680ba7cadb790aea8b025ae7aa6d18daba0
MD5 1f6037e0b2c9e5ced5e74ff714944cbf
BLAKE2b-256 f5fa19b917079a1afe6915234c1f99d710957a836a39556837be12d3dd49783e

See more details on using hashes here.

Supported by

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