tcal

Program for the calculation of transfer integral

https://github.com/matsui-lab-yamagata/tcal

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README
  • Academic publication links
    Links to: rsc.org, acs.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Program for the calculation of transfer integral

Basic Info
  • Host: GitHub
  • Owner: matsui-lab-yamagata
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 52.2 MB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

tcal: Program for the calculation of transfer integral

Python License: MIT docs

Requirements

  • Python 3.7 or newer
  • NumPy
  • Gaussian 09 or 16

Important notice

  • The path of the Gaussian must be set.

Options

|Short|Long|Explanation| |----|----|----| |-a|--apta|Perform atomic pair transfer analysis.| |-c|--cube|Generate cube files.| |-g|--g09|Use Gaussian 09. (default is Gaussian 16)| |-h|--help|Show options description.| |-l|--lumo|Perform atomic pair transfer analysis of LUMO.| |-m|--matrix|Print MO coefficients, overlap matrix and Fock matrix.| |-o|--output|Output csv file on the result of apta.| |-r|--read|Read log files without executing Gaussian.| |-x|--xyz|Convert xyz file to gjf file.| ||--napta N1 N2|Perform atomic pair transfer analysis between different levels. N1 is the number of level in the first monomer. N2 is the number of level in the second monomer.| ||--hetero N|Calculate the transfer integral of heterodimer. N is the number of atoms in the first monomer.| ||--nlevel N|Calculate transfer integrals between different levels. N is the number of levels from HOMO-LUMO. N=0 gives all levels.| ||--skip N...|Skip specified Gaussian calculation. If N is 1, skip 1st monomer calculation. If N is 2, skip 2nd monomer calculation. If N is 3, skip dimer calculation.|

How to use

1. Create gjf file

First of all, create a gaussian input file as follows:
ex: xxx.gjf
gjf_file_example
The xxx part is an arbitrary string.

Description of link commands

pop=full: Required to output coefficients of basis functions, overlap matrix, and Fock matrix.
iop(3/33=4,5/33=3): Required to output coefficients of basis functions, overlap matrix, and Fock matrix.

How to create a gjf using Mercury

  1. Open cif file in Mercury.
  2. Display the dimer you want to calculate.
    Anthracene_dimer
  3. Save in mol file or mol2 file.
  4. Open a mol file or mol2 file in GaussView and save it in gjf format.

2. Execute tcal.py

Suppose the directory structure is as follows.
yyy tcal.py xxx.gjf 1. Open a terminal. 2. Go to the directory where the files is located. cd yyy 3. Execute the following command. python python tcal.py -a xxx.gjf

3. Visualization of molecular orbitals

  1. Execute the following command. python python tcal.py -cr xxx.gjf
  2. Open xxx.fchk in GaussView.
  3. [Results] → [Surfaces/Contours...] visualize1
  4. [Cube Actions] → [Load Cube]
  5. Open xxxm1HOMO.cube and xxxm2HOMO.cube. visualize2
  6. Visualize by operating [Surface Actions] → [New Surface]. visualize3
    visualize4

Interatomic transfer integral

For calculating the transfer integral between molecule A and molecule B, DFT calculations were performed for monomer A, monomer B, and the dimer AB. The monomer molecular orbitals $\ket{A}$ and $\ket{B}$ were obtained from the monomer calculations. Fock matrix F was calculated in the dimer system. Finally the intermolecular transfer integral $t^{[1]}$ was calculated by using the following equation:

$$t = \frac{\braket{A|F|B} - \frac{1}{2} (\epsilon{A}+\epsilon{B})\braket{A|B}}{1 - \braket{A|B}^2},$$

where $\epsilonA \equiv \braket{A|F|A}$ and $\epsilonB \equiv \braket{B|F|B}$.

In addition to the intermolecular transfer integral in general use, we developed an interatomic transfer integral for further analysis $^{[2]}$. By grouping the basis functions $\ket{i}$ and $\ket{j}$ for each atom, the molecular orbitals can be expressed as

$$\ket{A} = \sum^A{\alpha} \sum^{\alpha}i a_i \ket{i},$$

$$\ket{B} = \sum^B{\beta} \sum^{\beta}j b_j \ket{j},$$

where $\alpha$ and $\beta$ are the indices of atoms, $i$ and $j$ are indices of basis functions, and $ai$ and $bj$ are the coefficients of basis functions. Substituting this formula into aforementioned equation gives

$$t = \sum^A{\alpha} \sum^B{\beta} \sum^{\alpha}i \sum^{\beta}j a^*i bj \frac{\braket{i|F|j} - \frac{1}{2} (\epsilonA + \epsilonB) \braket{i|j}}{1 - \braket{A|B}^2}$$

Here we define the interatomic transfer integral $u_{\alpha\beta}$ as:

$$u{\alpha \beta} \equiv \sum^{\alpha}i \sum^{\beta}j a^*i bj \frac{\braket{i|F|j} - \frac{1}{2} (\epsilonA + \epsilon_B) \braket{i|j}}{1 - \braket{A|B}^2}$$

References

[1] Veaceslav Coropceanu et al., Charge Transport in Organic Semiconductors, Chem. Rev. 2007, 107, 926-952.
[2] Koki Ozawa et al., Statistical analysis of interatomic transfer integrals for exploring high-mobility organic semiconductors, Sci. Technol. Adv. Mater. 2024, 25, 2354652.

Citation

When publishing works that benefited from tcal, please cite the following article.
Koki Ozawa, Tomoharu Okada, Hiroyuki Matsui, Statistical analysis of interatomic transfer integrals for exploring high-mobility organic semiconductors, Sci. Technol. Adv. Mater., 2024, 25, 2354652.
DOI: 10.1080/14686996.2024.2354652

Example of using tcal

  1. Satoru Inoue et al., Regioisomeric control of layered crystallinity in solution-processable organic semiconductors, Chem. Sci. 2020, 11, 12493-12505.
  2. Toshiki Higashino et al., Architecting Layered Crystalline Organic Semiconductors Based on Unsymmetric -Extended Thienoacenes, Chem. Mater. 2021, 33, 18, 73797385.
  3. Koki Ozawa et al., Statistical analysis of interatomic transfer integrals for exploring high-mobility organic semiconductors, Sci. Technol. Adv. Mater. 2024, 25, 2354652.

Authors

Matsui Laboratory, Research Center for Organic Electronics (ROEL), Yamagata University
Hiroyuki Matsui, Koki Ozawa
Email: h-matsui[at]yz.yamagata-u.ac.jp
Please replace [at] with @

Acknowledgements

This work was supported by JST, CREST, Grand Number JPMJCR18J2.

Owner

  • Name: Hiroyuki Matsui
  • Login: matsui-lab-yamagata
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
title: "tcal"
type: software
authors:
  - family-names: "Matsui"
    given-names: "Hiroyuki"
  - family-names: "Ozawa"
    given-names: "Koki"
version: 1.0
license: MIT
url: "https://github.com/matsui-lab-yamagata/tcal"

message: "When publishing works that benefited from tcal, please cite the following article."
preferred-citation:
  type: article
  authors:
  - family-names: "Ozawa"
    given-names: "Koki"
    orcid: "https://orcid.org/0009-0000-0732-1796"
  - family-names: "Okada"
    given-names: "Tomoharu"
  - family-names: "Matsui"
    given-names: "Hiroyuki"
    orcid: "https://orcid.org/0000-0003-1956-9603"
  title: "Statistical analysis of interatomic transfer integrals for exploring high-mobility organic semiconductors"
  journal: "Science and Technology of Advanced Materials"
  year: 2024
  volume: 25
  issue: 1
  pages: 2354652
  doi: "10.1080/14686996.2024.2354652"

GitHub Events

Total
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2
Last Year
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Watch event: 2
  • Delete event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2