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)

Note: the dependencies will be automatically installed via pip.

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-2.0.0.tar.gz (12.7 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: tb-mean-field-hubbard-2.0.0.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for tb-mean-field-hubbard-2.0.0.tar.gz
Algorithm Hash digest
SHA256 4d3bfbed6b76e0d96aa181f5c18feaf75d8c2f03e72172364932c84d2df67f66
MD5 f15320166d814b98133bf8b27efb8587
BLAKE2b-256 8659b5cab30047c54f3bda769f4e266361ab61be9b604db84520a513cfac45ce

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