Skip to content
Carlos E. V. de Moura edited this page Dec 9, 2024 · 10 revisions

Welcome to the Fanpy wiki!

Web: Miranda Quintana Group

Getting Started

What is Fanpy?

Fanpy is a free, open-source, and cross-platform Python 3 library designed for ab initio electronic structure calculations. The Fanpy implementation is based on the mathematical framework called Flexible Ansatz for N-electron Configuration Interaction (FANCI).

$$ | \Psi_{\mathrm{FANCI}} \rangle = \sum_{\mathbf{m} \in \mathbf{S_m}} f\left( \mathbf{m}, \vec{P} \right) | \mathbf{m} \rangle $$

where $\mathbf{S_m}$ is a set of allowed Slater determinants and $f$ is a function that determines the weight of each Slater determinant, $\mathbf{m}$, using the parameters $\vec{P}$.

The FANCI ansatz offers a general wave-function structure that can be applied to various electronic structure theories, including Configuration Interaction (CI), Coupled-Cluster (CC), Tensor Product States (TPS), and Antisymmetrized Product of Interacting Geminals (APIG) wavefunctions.

What is Fanpy for?

Fanpy, a quantum chemistry code, offers tools to aid in developing novel electronic structure ansatz. Unlike other codes that provide well-established quantum methods and theories from the literature or recently developed by the group for a broader audience, Fanpy focuses on providing resources for researchers seeking to build new wavefunctions to solve chemical problems.

How Fanpy works? The Modular structure of Fanpy

The FANCI framework provides a highly modular structure to Fanpy, resulting in five modules: Hamiltonian, Wavefunction, Objective, Solver, and Tools. This modular structure offers two significant advantages. Firstly, it enables a ‘sandbox-like’ approach to handling various combinations of wavefunction ansatz and different methods. Secondly, it simplifies the transition from the theoretical formulation of a method to its practical implementation.

Fanpy-Modules

Publications

For detailed information about the mathematical formulation, please take a look at the FANCI publication. The official notes of the Fanpy library can be found in this article.

Clone this wiki locally