PyCI: A Python-scriptable library for arbitrary determinant CI

• Published in: The Journal of chemical physics Vol. 161; no. 13
• Main Authors: Richer, Michelle, Sánchez-Díaz, Gabriela, Martínez-González, Marco, Chuiko, Valerii, Kim, Taewon David, Tehrani, Alireza, Wang, Shuoyang, Gaikwad, Pratiksha B., de Moura, Carlos E. V., Masschelein, Cassandra, Miranda-Quintana, Ramón Alain, Gerolin, Augusto, Heidar-Zadeh, Farnaz, Ayers, Paul W.
• Format: Journal Article
• Language: English
• Published: United States American Institute of Physics 07.10.2024
• Subjects: Computation; Configuration interaction; Electron spin; Libraries; Python; Quantum chemistry; Residual energy; Software development
• ISSN: 0021-9606; 1089-7690; 1089-7690
• DOI: 10.1063/5.0219010

PyCI is a free and open-source Python library for setting up and running arbitrary determinant-driven configuration interaction (CI) computations, as well as their generalizations to cases where the coefficients of the determinant are nonlinear functions of optimizable parameters. PyCI also includes functionality for computing the residual correlation energy, along with the ability to compute spin-polarized one- and two-electron (transition) reduced density matrices. PyCI was originally intended to replace the ab initio quantum chemistry functionality in the HORTON library but emerged as a standalone research tool, primarily intended to aid in method development, while maintaining high performance so that it is suitable for practical calculations. To this end, PyCI is written in Python, adopting principles of modern software development, including comprehensive documentation, extensive testing, continuous integration/delivery protocols, and package management. Computationally intensive steps, notably operations related to generating Slater determinants and computing their expectation values, are delegated to low-level C++ code. This article marks the official release of the PyCI library, showcasing its functionality and scope.