Search arXivSearch

arXiv · 2411.18024

SPARC-X-API: Versatile Python Interface for Real-space Density Functional Theory Calculations

Abstract

Density Functional Theory (DFT) is the de facto workhorse for large-scale electronic structure calculations in chemistry and materials science. While plane-wave DFT implementations remain the most widely used, real-space DFT provides advantages in handling complex boundary conditions and scaling to very large systems by allowing for the efficient use of large-scale supercomputers and linear-scaling methods that circumvent the cubic scaling bottleneck. The SPARC-X project (https://github.com/SPARC-X) provides highly efficient and portable real-space DFT codes for a wide range of first principle applications, available in both Matlab (M-SPARC) and C/C++ (SPARC). The rapid growth of SPARC's feature set has created the need for a fully functional interface to drive SPARC in high-throughput calculations. Here we introduce SPARC-X-API, a Python package designed to bridge the SPARC-X project with broader computational frameworks. Built on the atomic simulation environment (ASE) standard, the SPARC-X-API allows users to handle SPARC file formats and run SPARC calculations through the same interface as with other ASE-compatible DFT packages. Beyond standard ASE capabilities, SPARC-X-API provides additional features including 1) support of SPARC-specific setups, including complex boundary conditions and unit conversion, 2) a JSON schema parsed from SPARC's documentation for parameter validation and compatibility checks, and 3) a comprehensive socket communication layer derived from the i-PI protocol facilitating message passing between low-level C code and the Python interface. The goal of the SPARC-X-API is to provide an easy-to-use interface for users with diverse needs and levels of expertise, allowing for minimal effort in adapting SPARC to existing computational workflows, while also supporting developers of advanced real-space methods.

Explore related subjects

Keep this discovery

Explore connections, maps & timelines

BibTeXRIS

Tian Tian, Lucas R Timmerman, Shashikant Kumar, Ben Comer, Andrew J Medford, Phanish Suryanarayana. 2024-11-27. SPARC-X-API: Versatile Python Interface for Real-space Density Functional Theory Calculations. https://arxiv.org/abs/2411.18024

Cite the original work for its findings. Save a collection to share your selection of sources.

KEEP EXPLORING

Related papers

Charge Transfer with a Spin. I: A Variational Constrained-CASSCF Framework for Investigating Charge Transfer in the Presence of Spin-Orbit Coupling

Charge transfer in open-shell molecular systems can involve a delicate interplay between charge localization, orbital relaxation, and spin-orbit coupling (SOC), particularly near ground-excited state crossings. Here, we introduce a very inexpensive variational framework for treating these effects in odd-electron systems by extending the electron/hole-transfer Dynamically-weighted State-Averaged Constrained CASSCF (eDSC/hDSC) method to include SOC. Our method incorporates the SOC Hamiltonian directly into the variational orbital optimization through complex-valued spinor orbitals, allowing orbital and spin degrees of freedom to relax self-consistently while preserving the time-reversal symmetry of doublet states. The method achieves smooth potential energy surfaces and rapid self-consistent field (SCF) convergence; moreover, from physically small to artificially large SOC strengths, the calculation can be converged to very tight thresholds across the whole potential energy surface. While the results presented here are for systems with two charge centers, as shown in the appendix, the theory is quite general and can be adapted to either a system of $N$ charge centers or a metal-molecule surface with a continuum of states, so that charge transport (and not just charge transfer) can also be studied. The approach therefore provides a route towards ab initio studies of spin-dependent charge transfer and charge transport in molecular systems with nontrivial spin degrees of freedom.

physics.chem-ph

Charge Transfer with a Spin. II: A Framework for Diabatization which Localizes Charge and Spin

We investigate a diabatization procedure that localizes charges (in real space) and localizes spins (in spin space) for open-shell systems that exhibit charge transfer in the presence of spin-orbit coupling. The procedure is applied to a two-state crossing between pairs of Kramers-restricted doublet states (which can also be considered effectively a four-state crossing). To generate the relevant diabatic states, we employ a two-step optimization over complex-unitary rotations that sequentially maximizes dipole and spin moments through iterative Jacobi sweeps; the resulting update rules are effectively equivalent to those of approximate joint diagonalization (AJD) applied to charge and spin. The method converges rapidly and yields smooth diabatic potential energy surfaces that preserve dipole and spin properties (e.g., a smoothly varying spin quantization axis) along the reaction coordinate while maintaining time-reversal symmetry.

physics.chem-ph

Fixed-Dimensional Latent Flow for Generating Variable-Size 3D Molecules

Molecular size is coupled to composition, structure, and function, yet most 3D molecular generators require a predefined atom count. We introduce Equivariant-Free Transformer-Autoencoded Latent Flow Matching, a two-stage framework that samples a fixed-dimensional latent vector using flow matching and uses an autoregressive Transformer to determine molecular size, atom types, coordinates, and chemical attributes. Canonical atom ordering and rigid-pose alignment enable Transformers without equivariant layers, while decoded attributes guide bond reconstruction. On PCQM4Mv2, unconditional generation yields 87.9\% unique, novel molecules passing sanitization and PoseBusters checks, exceeding baselines with lower end-to-end training and sampling time and higher end-to-end throughput. Across ten target HOMO-LUMO gaps, internal ranking retains 30\% of screened candidates and increases the density functional theory-verified hit rate within 0.1 eV from 25.0\% to 52.4\%, while largely preserving novelty and diversity. These results demonstrate fixed-dimensional latent generation with autoregressive decoding as a practical approach to molecular design without prespecifying size.

physics.chem-ph