Skip to main content

Package to run tight-binding mean field hubbard calculations

Project description

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) To install the dependencies and the library, and to have 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 .

Option 2) To just install the dependencies and the library

pip install git+https://github.com/eimrek/tb-mean-field-hubbard.git#egg=tb-mean-field-hubbard

Option 3) If dependencies are already installed, then simply downloading the code and executing the notebook will work.

In all cases, 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 mfh.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.2.0.tar.gz (8.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: tb-mean-field-hubbard-1.2.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.6.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for tb-mean-field-hubbard-1.2.0.tar.gz
Algorithm Hash digest
SHA256 a754ee599db4ad759fc774068613612719bad9e604e91ec9a80ec09df9b256e2
MD5 95b407e17d95db50bbcff8732306c4e1
BLAKE2b-256 1bfe2cbc3dd6e8e0a42981b9e64f151f3558e9d83e15bd6f064958dfcd8e2d73

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