JoshuaSBrown / QC_Tools

This small repository provides functionality for calculating the charge transfer integrals between two molecules.
MIT License
29 stars 14 forks source link
charge-transport chemistry quantum transfer-integral

CATNIPLOGO

QC_Tools or CATNIP - ChArge TraNsfer Integral Package

Badges

Codacy Badge Join the chat at https://gitter.im/QC_Tools/Lobby [Github All Releases]() Build Status codecov CodeFactor Total alerts Language grade: C/C++ Quality Gate Status

Updates

Message to users:

  1. NOTE - CATNIP is dependent on the precision of the log output of the Guassian files, if you need highly accurate calculations, this tool is probably not the best tool. It would be better to use something like NWChem that solves for the transfer integral self consistently.
  2. The wiki has been ported to github pages, I have left the documentation in the wiki but it will become deprecated in the future.
  3. Version 2.0 is in the works, will provide additional functionality.

Documentation

Objective

CATNIP is meant to make difficult calculations accessible to the masses. The focus is to accelerate science and industry by:

I welcome feedback and contributors. If you have suggestions for integrating CATNIP with other programs please do not hesitate to create an issue or contact me on gitter. You can do this by clicking on the gitter badge.

If you run into a problem feel free to create an issue on github, just be sure to give me enough information to reproduce the error, otherwise I won't be able to fix it. If I do not respond promptly feel free to reach out again. Often responses get filtered to my spam folder or I simply do not see them.

Citing

If you use CATNIP to get values for a paper it would be nice if you cited it. To know how to cite it you can simply pass the folloing -cite flag to calc_J as:

calc_J -cite

It would also be nice if you starred the repo... if you find it useful.

Acknowledgements and Relevant Papers

[1] B. Baumeier, J. Kirkpatrick, and D. Andrienko, “Density-functional based determination of intermolecular charge transfer properties for large-scale morphologies,” Phys. Chem. Chem. Phys., vol. 12, no. 36, p. 11103, 2010.
[2] E. F. Valeev, V. Coropceanu, D. a da Silva Filho, S. Salman, and J.-L. Brédas, “Effect of electronic polarization on charge-transport parameters in molecular organic semiconductors.,” J. Am. Chem. Soc., vol. 128, no. 30, pp. 9882–6, Aug. 2006.

The author would like to acknowledge insightful correspondence with E. F. Valeev and B. Baumeier.

Thanks to the following for helping to make CATNIP better