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.
Skip Nav Destination
,
,
,
,
,
,
,
,
,
,
,
,
,
Article navigation
7 October 2024
Research Article|
October 04 2024
PyCI: A Python-scriptable library for arbitrary determinant CI Available to Purchase
Special Collection:
Modular and Interoperable Software for Chemical Physics
Michelle Richer
;
Michelle Richer
(Conceptualization, Formal analysis, Investigation, Methodology, Project administration, Software, Writing – original draft, Writing – review & editing)
1
Department of Chemistry, Queen’s University
, 90 Bader Lane, Kingston, Ontario K7L 3N6, Canada
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Gabriela Sánchez-Díaz
;
Gabriela Sánchez-Díaz
(Conceptualization, Formal analysis, Investigation, Software, Writing – review & editing)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Marco Martínez-González
;
Marco Martínez-González
(Methodology, Software, Writing – review & editing)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Valerii Chuiko;
Valerii Chuiko
(Software, Writing – review & editing)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Taewon David Kim
;
Taewon David Kim
(Conceptualization, Methodology, Software)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
3
Department of Chemistry and Quantum Theory Project, University of Florida
, Gainesville, Florida 32603, USA
Search for other works by this author on:
Alireza Tehrani
;
Alireza Tehrani
(Methodology, Software)
1
Department of Chemistry, Queen’s University
, 90 Bader Lane, Kingston, Ontario K7L 3N6, Canada
Search for other works by this author on:
Shuoyang Wang
;
Shuoyang Wang
(Software)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Pratiksha B. Gaikwad
;
Pratiksha B. Gaikwad
(Software)
3
Department of Chemistry and Quantum Theory Project, University of Florida
, Gainesville, Florida 32603, USA
Search for other works by this author on:
Carlos E. V. de Moura
;
Carlos E. V. de Moura
(Software)
3
Department of Chemistry and Quantum Theory Project, University of Florida
, Gainesville, Florida 32603, USA
Search for other works by this author on:
Cassandra Masschelein;
Cassandra Masschelein
(Software)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
Search for other works by this author on:
Ramón Alain Miranda-Quintana
;
Ramón Alain Miranda-Quintana
(Software, Supervision, Writing – review & editing)
3
Department of Chemistry and Quantum Theory Project, University of Florida
, Gainesville, Florida 32603, USA
Search for other works by this author on:
Augusto Gerolin;
Augusto Gerolin
(Funding acquisition, Supervision)
4
Department of Mathematics and Statistics, and Department of Chemistry and Biomolecular Sciences, University of Ottawa
, 150 Louis-Pasteur Pvt, Ottawa, Ontario K1N 6N5, Canada
5
Nexus for Quantum Technologies, University of Ottawa
, Ottawa, Ontario K1N 6N5, Canada
Search for other works by this author on:
Farnaz Heidar-Zadeh
;
Farnaz Heidar-Zadeh
(Conceptualization, Formal analysis, Funding acquisition, Investigation, Methodology, Project administration, Resources, Software, Supervision, Writing – original draft, Writing – review & editing)
1
Department of Chemistry, Queen’s University
, 90 Bader Lane, Kingston, Ontario K7L 3N6, Canada
Search for other works by this author on:
Paul W. Ayers
Paul W. Ayers
a)
(Conceptualization, Formal analysis, Funding acquisition, Methodology, Project administration, Resources, Software, Supervision, Writing – original draft, Writing – review & editing)
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
a)Author to whom correspondence should be addressed: [email protected]
Search for other works by this author on:
Michelle Richer
1,2
Gabriela Sánchez-Díaz
2
Marco Martínez-González
2
Valerii Chuiko
2
Taewon David Kim
2,3
Alireza Tehrani
1
Shuoyang Wang
2
Pratiksha B. Gaikwad
3
Carlos E. V. de Moura
3
Cassandra Masschelein
2
Ramón Alain Miranda-Quintana
3
Augusto Gerolin
4,5
Farnaz Heidar-Zadeh
1
Paul W. Ayers
2,a)
1
Department of Chemistry, Queen’s University
, 90 Bader Lane, Kingston, Ontario K7L 3N6, Canada
2
Department of Chemistry and Chemical Biology, McMaster University
, 1280 Main St. West, Hamilton, Ontario L8S 4M1, Canada
3
Department of Chemistry and Quantum Theory Project, University of Florida
, Gainesville, Florida 32603, USA
4
Department of Mathematics and Statistics, and Department of Chemistry and Biomolecular Sciences, University of Ottawa
, 150 Louis-Pasteur Pvt, Ottawa, Ontario K1N 6N5, Canada
5
Nexus for Quantum Technologies, University of Ottawa
, Ottawa, Ontario K1N 6N5, Canada
a)Author to whom correspondence should be addressed: [email protected]
J. Chem. Phys. 161, 132502 (2024)
Article history
Received:
May 14 2024
Accepted:
August 21 2024
Citation
Michelle Richer, Gabriela Sánchez-Díaz, Marco Martínez-González, Valerii Chuiko, Taewon David Kim, Alireza Tehrani, Shuoyang Wang, Pratiksha B. Gaikwad, Carlos E. V. de Moura, Cassandra Masschelein, Ramón Alain Miranda-Quintana, Augusto Gerolin, Farnaz Heidar-Zadeh, Paul W. Ayers; PyCI: A Python-scriptable library for arbitrary determinant CI. J. Chem. Phys. 7 October 2024; 161 (13): 132502. https://doi.org/10.1063/5.0219010
Download citation file:
Pay-Per-View Access
$40.00
Sign In
You could not be signed in. Please check your credentials and make sure you have an active account and try again.
Citing articles via
DeePMD-kit v2: A software package for deep potential models
Jinzhe Zeng, Duo Zhang, et al.
CREST—A program for the exploration of low-energy molecular chemical space
Philipp Pracht, Stefan Grimme, et al.
Related Content
ModelHamiltonian: A Python-scriptable library for generating 0-, 1-, and 2-electron integrals
J. Chem. Phys. (October 2024)
FUDGE: A Program for Performing Nuclear Data Testing and Sensitivity Studies
AIP Conf. Proc. (May 2005)
Grid : A Python library for molecular integration, interpolation, differentiation, and more
J. Chem. Phys. (May 2024)
GBasis : A Python library for evaluating functions, functionals, and integrals expressed with Gaussian basis functions
J. Chem. Phys. (July 2024)
Vision for unified micromagnetic modeling (UMM) with Ubermag
AIP Advances (January 2024)