Changelog#
Unreleased#
Breaking changes#
Raised LibRPA’s CMake minimum to 3.18 to match its own use of
FindCUDAToolkitandCMP0104. The standalone download and source-preparation scripts remain compatible with 3.13.Stopped shipping third-party sources. Default configuration uses network access, cached archives or prepared sources. For offline builds, download archives with
cmake/LibRPADownloadThirdparty.cmakeon a connected machine and transfer them to the build machine.Resolve explicit include directories without searching system paths. Invalid paths stop configuration without a download fallback.
Changed the real-space EXX and Sigma_c output to one indexed binary layout. EXX writes one
ExxR_ispin_SS_s_BK_myid_NNNNN.binfile per MPI rank and spin/spinor channel instead of one file per (I,J,R) block, and keeps its real or complex storage. Sigma_c changes its extension from.datto.binand stores its frequency in the header. Every file starts with a header that holds a magic string, a byte-order marker, the layout version, the kind, the number of ranks, the rank, the scalar type, the block count, and a run identifier shared by all files of one output. A reader takes the file set from the file of rank 0 (its rank count and run identifier), uses ranks0..nprocs-1of that run, and ignores files of higher ranks, which an earlier run with more ranks leaves in the directory. The Sigma_c restart does this and stops on a missing file or a file of another run. External readers and filename patterns must be updated (#65).Removed automatic loading of
cmake.incand theLIBRPA_USE_CMAKE_INCbuild option. Use CMake-Cinitial cache files or-Darguments instead (#85).
Added#
Added
LIBRPA_THIRDPARTY_ARCHIVE_DIRfor archive storage,LIBRPA_THIRDPARTY_DOWNLOAD, and separate download and source-preparation scripts with archive SHA-256 verification. Prepared sources stay in each checkout’sthirdparty/src/. Local source edits are preserved with anunpinnedwarning.Added
LIBDDLA_SOURCE_DIR,GREENX_SOURCE_DIRandELPA_SOURCE_DIRfor local source builds, pristine LibComm/greenX/ELPA overlays, parent dependency targets, and dependency source summaries. AddedGREENX_PATHfor installations, with compatibility warnings for prebuilt greenX, ELPA and LibDDLA. Rejected ambiguous source/installation paths.Added opt-in AAA and ridge analytic continuation for GW/QSGW/cRPA, retaining the original Pade default. Set
anacon_method=aaaoranacon_method=ridge; ridge uses coefficient penalty1e-12and denominator weight10unless overridden. Values and derivatives are shared by quasiparticle solvers, spectra, resampling and QSGW matrices. Rebuild host bindings for the extended options structure. Unmet AAA tolerance is reported; numerical continuation failures leave affected GW diagnostic states or spectral frequencies as NaN. The standalone cRPA fit retains all source nodes independently of GW counts.Added conventional k-space RPA energies, for all parallel routings and for builds without LibRI. Required replicated scalar or collinear eigenvectors on the full k mesh,
use_symmetry_rpa = false, anduse_shrink_abfs = false.Added the option
chi0_method(auto,space_time,conventional) and the enumLibrpaMethod.autoselected the conventional method on frequency-only grids such astfgrids_type = GL, and the space-time method otherwise.conventionalalso used the frequency nodes of grids with time nodes, such asminimax.Rejected frequency-only grids and
chi0_method = conventionalat the start of GW and cRPA calculations.Stopped RPA energy calculations at the start in builds without LibRI when
use_scalapack_ecrpa = truewith theatompairorlibrirouting. They previously stopped after the response was built.
Changed#
GreenX selection now uses the supplied target, source path or installation prefix, with managed sources as the default. The legacy selection switch is deprecated and ignored.
Renamed ELPA source-build settings to
LIBRPA_ELPA_KERNEL,LIBRPA_ELPA_OPENMP,LIBRPA_ELPA_CONFIGURE_ARGSandLIBRPA_ELPA_LIBS. Source versions now come from the selected source tree; the manifest controls the downloaded release.Standardized installation prefix options as
LIBDDLA_PATH,ELPA_PATHandGREENX_PATH.Unified ELPA selection under
LIBRPA_USE_ELPA, which defaults toOFF. Setting it toONbuilds managed sources when no dependency is supplied. A parent ELPA target, source path or installation prefix enables ELPA automatically.Updated cereal to
d81e2f7df7b334fee057e53017388d02e555a836.Updated LibRI to
ab81ac9, which includes the portable allocator cleanup. LibRPA no longer patches LibRI. Headers ofa0661cbwith the former patch now have statusunpinned.
Deprecated#
Deprecated legacy
SigcRF_*.datcheckpoints. Restart still reads them with a warning; new checkpoints use the indexed.binformat. Legacy reading will be removed in a future release (#65). The legacy files have no header, so the restart still takes their rank count from the largest rank in the file names; leftover files of an earlier run with more ranks must be removed by hand.
Fixed#
Ignored Git metadata (
.gitfile or directory) at the root of a user-supplied source path when computing third-party tree hashes. A submodule or clone at the pinned commit now has statuspinnedand notunpinned. Overlay copies leave out the root.git, so patching works for a submodule.Detected parent greenX targets automatically, avoiding duplicate targets.
Corrected the LibDDLA revision in the license list to
0d576d4.Passed the OpenMP runtime to the ELPA source build with MKL, so that ELPA’s
configurecan linkmkl_intel_thread.Handled ranks with no local Wc elements in the complex cosine transform of Wc, which divided by zero when computing batch sizes (#65).
Fixed the
map::atfailure of RPA energies withparallel_routing = rtaufor more than one q point on more than one MPI rank.Restored the full-BZ
W(R)reconstruction for the auxiliary-basis shrink path when the k list holds every Brillouin-zone member, which is how the FHI-aims reader exports its SCF k-points. Both k-point forms, the reduced (IBZ) list and the full-Brillouin-zone list, are now accepted and reach the same accumulation.Linked
mkl_gnu_threadfor GCC C++ and selected the MKL BLACS library from the MPI headers. Configuration rejects detected OpenMP runtime conflicts in ELPA source builds and prebuilt dependencies.
0.9.0 - 2026-10-31#
Breaking changes#
Replaced
task = qsgw_bandwithtask = qsgwfor grid and band-path calculations. Used band-path input metadata to select the optional band channel (#67).Renamed
qsgw_band0_*controls toqsgw_unoccupied_keep,qsgw_cut_mode, andqsgw_cut_shift_ha. Assigned the shifted-reference cut to mode 1 and rejected the former mode 2. Changed the default cut shift to 2 eV. Kept explicitqsgw_cut_shift_havalues in Hartree (#67).Enabled complete native real-space QSGW Hamiltonian export by default. Required
qsgw_export_hamiltonian_for_pyatb = falsefor inputs without matching native ABACUS H(R), S(R), and r(R) files (#67).Enabled QSGW Hartree density feedback by default. Required dedicated
prefix_coul_hartreeandprefix_lri_coeff_hartreeinputs for this feature. Kept fixed-Hartree calculations available throughqsgw_update_hartree = false(#73).Updated
input_preset = abacusto current reader-v1 filenames and prefixes. Kept older exports accessible throughabacus-legacyor explicit filename overrides (#49).Removed the separate bundled
thirdparty/LibRI_GPUtree and unified CPU/GPU builds underthirdparty/LibRI. Used LibDDLA for CUDA and HIP tensor contractions. Required external GPU-enabled LibRI headers to support__GPU_RI, the DDLA backend, andRI::LRI_Cal_Mode::GPU. Required LibRI and one GPU backend forLIBRPA_USE_LIBRI_GPU. Kept CPU tensor contractions when this option is off (#76).Stopped installing the experimental
file_reader.hppandlibrpa_file_reader.hppheaders and thelibrpa_file_readerlibrary. The headers include headers undersrc/and work only from a LibRPA source tree. Builtlibrpa_file_readeras a static library with position-independent code, so the installed driver does not depend on it at run time (#78).
Added#
Added experimental
task = crpafor bare, partially screened, and fully screened onsite interaction tensors, with independent response and local-orbital spaces, band or orbital-projector response weights, and scalar/spinor support. Added orbital-character and PDOS analysis, G0W0/QSGW coupling, and local-frame tracking with QSGW checkpoint continuation. Extendedoption_dielect_func = 6to native optical calculations in cRPA (#71).Extended experimental fixed-basis QSGW with checkpoint restart, per-update quasiparticle solutions, and live same-grid analytic head/wing updates. Added
option_dielect_func = 6for current-HR QSGW velocities and a public C/C++ task API available without the standalone driver. Added regression checks for iteration and restart workflows (#67).Added experimental standalone periodic Hartree AO matrices through LibRI. Limited standalone Hartree and QSGW Hartree feedback to a complete regular Gamma-containing 3D SCF grid with
bloch_ratom = 0. Required a dedicated bare q=0 Coulomb metric with G=0 set to zero (#73).Added native optical velocities from H(R), S(R), and r(R), public velocity preparation APIs, and driver preset
option_dielect_func = 6for G0W0 analytic head/wing calculations. Added numerical checks for native velocities (#70).Added explicit
spin_symmetryinput and spatial/spin operation tables for SOC symmetry restoration (#43).Added unitary/antiunitary magnetic reconstruction for SOC exchange, optical head/wing calculations, and cRPA. Validated compatible states and correlated subspaces (#72).
Added experimental strict-2D analytic head/wing screening and Gamma-cell RPA integration. Documented the reader-v1
librpa_2d_coulomb_head.txtcontract for complete Wc calculations. Aligned Gamma body, wing, and Coulomb legs in the same eigenbasis and corrected Wc redistribution (#44).Added compact serial/MPI regressions for strict-2D complete Wc and Delta-Sternheimer head/wing calculations (#49).
Added experimental
task = sternheimer_rpafor Delta-Sternheimer RPA input and response reconstruction from aggregate or partial producer data, with symmetry routes and external frequency grids. Kept the consumer-side v1 input format provisional (#45).Added s-subspace dielectric-head replacement (
option_dielect_func = 5) and analytic head/wing correction (53). Limited option53to the ScaLAPACK Wc path for 3D G0W0 grid and band calculations (#64).Added
output_exx_mat_rfor binary real-space NAO EXX blocks, with MPI-independent filenames. Reused the Sigma_c real-space block writer and checkpoint layout for EXX (#48).Added
n_bands_exclude_chi0andn_bands_exclude_sigcto independently exclude the lowest input bands from response and correlation self-energy Green functions. Set both defaults to zero and left EXX unchanged (#41).Added optional explicit full-grid k-point mappings to the BZ input format (#53).
Changed#
Updated the design diagrams and added architecture views, with LaTeX and PlantUML sources and build targets to regenerate the figures (#75).
Removed the obsolete
gw_oldandmeanfield_oldsource and header files (#77).Updated bundled LibRI to
a0661cb(#74).Enabled CPU fine-grained locking when supported by the selected LibRI headers (#50).
Moved QSGW iteration state and checkpoint handling into the library core. Kept input parsing and output formatting in the driver (#67).
Strengthened regression comparisons to reject nonfinite results and expanded symmetry, MPI, and input-contract checks (#63).
Fixed#
Fixed allocator cleanup in bundled LibRI for macOS (#76).
Fixed driver test linking with MPI and math libraries in shared-library builds (#77).
Used external frequency nodes directly for Delta-Sternheimer head/wing calculations, avoiding redundant minimax-grid generation (#55).
Corrected Gamma screening to subtract the retained Coulomb projector after channel filtering. Added numerical checks for filtered-Coulomb screening (#70).
Corrected distributed head/wing layouts and RPA log-determinant handling (#51).
Corrected strict-2D Gamma-cell RPA integration by integrating the trace-log radially (#62).
Fixed Padé construction for zero or repeated samples using a checked barycentric fallback that preserves the selected samples and Padé degree class. Corrected scalar distributed matrix powers and rejected nonfinite minimax grids and transform coefficients before use. Added numerical checks for these paths (#70).
Corrected SOC charge vertices and reversed Green-function buffers (#69).
Corrected k-star wavefunction rotations and supercell symmetry handling (#54).
Restored supercell q-star Coulomb reconstruction and ensured unique Coulomb ownership across MPI ranks (#59).
Corrected the operator transformation of real-space self-energy (#56).
Restored occupations using per-IBZ k-point weights (#52).
Canonicalized BvK k-point coordinates (#40).
Handled empty local wavefunction blocks in scalar and spinor k-point/BLACS calculations (#60).
Rejected symmetry-reduced SCF k-grids when
use_symmetry_exx = falseinstead of producing incomplete exchange results (#68).Applied
n_bands_chi0andn_bands_sigcto response and correlation self-energy Green functions across serial and k-point/BLACS-parallel routes. Rejected band upper bounds exceeding the input size. Preserved k-parallel blocks, zero-response frequency entries, and one-sided or zero self-energies when bands are excluded (#41).Adapted scalar and spinor symmetry restoration helpers to band masks and cutoffs (#43).
Fixed distributed Wc Hermitian completion and compressed auxiliary-basis unfolding (#42).
Fixed distributed Wc export scheduling to keep MPI collectives aligned across ranks with different local frequency data (#43).
Fixed out-of-bounds access in binary v1 LRI and Coulomb readers when input files contain zero data blocks (#39).
Corrected the ABACUS preset Vxc filename (#53).
0.8.0 - 2026-09-23#
Breaking changes#
Changed
output_gw_sigc_mat_kfNAO self-energy exports from Matrix Market.mtxto dense binary.bin. Update readers ofSigcKF_*output to the format documented inlibrpa_options.h.Changed the default number of time/frequency points,
nfreq, from 6 to 16.
Added#
Added experimental fixed-basis
qsgwandqsgw_bandtasks with native FHI-aims/ABACUS Vxc input, Hamiltonian mixing and truncation, and iteration diagnostics. Same-grid analytic head correction is supported; Hartree, independent-grid head, and wing updates remain unsupported.Added
input_presetforfhi-aims(aliasaims),abacus, andabacus-legacy, plus configurableprefix_velocity. The legacy preset retains unsuffixed ABACUS filenames and the ABACUS velocity reader.Added
output_exx_mat_kfor dense binary NAO-basis EXX matrices on the k-grid and band path, including spinor blocks.Added binary regression-data extraction with selectable field groups.
Added detailed profiling of Green-function construction, response collection, matrix operations, and MPI waits.
Changed#
Changed CPU LibRI EXX, response, and GW work distribution to use weights based on the number of basis functions on each atom, and updated bundled LibRI.
Changed driver file-reader organization through a major refactor, moving shared readers into
driver/readerand the experimentallibrpa_file_readerlibrary, independent of driver state and available withLIBRPA_ENABLE_DRIVER=OFF. Thefile_reader.hppAPI lets external programs, such as LibBSE, reuse LibRPA dataset formats and file parsing, with configurable input filenames and prefixes.
Fixed#
Fixed Gamma head/wing corrections for filtered Coulomb subspaces, including the case with only the head channel retained, and avoided forming the full body projector during matrix construction.
Fixed missing ELSI CSC size and index validation and unaligned value reads.
Fixed missing KS, EXX, and GW band-edge and gap analysis on the k-grid and band path, retaining the mean-field occupied/empty band partition and adding warnings for higher empty GW states below the mean-field Fermi level.
Fixed suppressed RPA, EXX, and G0W0 result tables, timing summaries, and MPI/build information at
warningandcriticaloutput levels.Fixed output-level filtering for structural and time/frequency-grid diagnostics and collective messages.
Fixed missing propagation of library feature definitions to CMake consumers, keeping exposed C++ data types consistent with the library build.
0.7.0 - 2026-08-02#
Breaking changes#
API
librpa_set_kgrids_kvecchanged to accept the number of loaded SCF k-points explicitly and optional k-point weights. C++/Fortran bindings changed accordingly:set_kgrids_kvec.API
librpa_set_ibz_mappingwas renamed tolibrpa_set_kq_mapping. C++/Fortran bindings changed accordingly:set_ibz_mappingwas renamed toset_kq_mapping.
Added#
New public APIs:
Global output control:
librpa_set_output_levelandlibrpa_get_output_level.Restart setup:
librpa_set_restart_from_dir.Auxiliary-basis and symmetry metadata:
librpa_set_ao_basis_aux_shrink,librpa_set_basis_convention, andlibrpa_set_symmetry_operations.Packed-complex Coulomb input:
librpa_set_aux_bare_coulomb_k_atom_pair_packed,librpa_set_aux_cut_coulomb_k_atom_pair_packed,librpa_set_aux_bare_coulomb_k_2d_block_packed, andlibrpa_set_aux_cut_coulomb_k_2d_block_packed.Velocity-matrix input:
librpa_set_velocity_matrixandlibrpa_set_velocity_matrix_packed.GW quasiparticle and spectral-function retrieval:
librpa_get_g0w0_qpe_kgrid,librpa_get_g0w0_qpe_band_k,librpa_get_g0w0_spectral_function_kgrid, andlibrpa_get_g0w0_spectral_function_band_k.
Added CUDA and HIP acceleration for EXX, RPA, GW, and head/wing calculations through LibDDLA, GPU-enabled LibRI, and optional ELPA routines.
Added support for bundled or external ELPA and bundled or external LibDDLA installations.
Added two-level k-point/BLACS parallelism for eigenvector redistribution, density and Green functions, EXX, response, and GW calculations.
Added versioned binary readers for Coulomb matrices, LRI coefficients, KS eigenvectors, and velocity matrices, with automatic format detection and legacy-data conversion utilities.
Added selectable iterative, quasi-Newton, and perturbative quasiparticle solvers, adaptive damping, fallback output, Hedin’s shift, and independent analytic-continuation grids and resampling.
Added symmetry-operation input APIs, basis-shell metadata, k-star reconstruction, and configurable Born-von Kármán remapping.
Added analytic GW and RPA head/wing workflows, response-collection chunking, and sparse-block handling.
Added restart loading from a separate directory and outputs for atom-pair screened interactions, k-frequency self-energies, ranged EXX/self-energy matrices, and binary spectral functions.
Changed#
Changed driver input handling to auto-detect supported dataset formats and exposed input filenames and prefixes as runtime parameters.
Changed the default Born-von Kármán remapping to consider multiple periodic images.
Changed the iterative quasiparticle solver to residual mixing and tightened its default convergence threshold.
Improved memory use and scaling in response Fourier transforms, screened interactions, self-energy rotation, and symmetry-enabled calculations.
Made the driver fail cleanly on missing input files, unknown tasks, and initialization or task exceptions while finalizing LibRPA and MPI as applicable.
Made the required MPI thread-support level configurable at build time and added startup reporting of the requested and provided levels.
Deprecated#
Deprecated
task = g0w0_band; usetask = g0w0. The old value remains an accepted alias.Deprecated the monolithic
basis_out,symrot_k, andirreducible_sector.txtinputs in favor of split basis data and parsed symmetry operations.Retained several renamed runtime parameters as compatibility aliases; the preferred names are listed in the runtime-parameter documentation.
Fixed#
Fixed symmetry reconstruction and k-parallel execution for EXX, RPA, GW, spinor wavefunctions, and head/wing corrections, including an MPI hang.
Fixed head/wing normalization, shrink-basis selection, GPU execution, and dielectric-solver error reporting.
Fixed small-basis calculations with large MPI task counts, non-LibRI response routes, distributed wavefunction layouts, and multiple input/output regressions.
0.6.0 - 2026-05-25#
Added#
Extended spin-orbit coupling and spinor-wavefunction support across input readers, public APIs, response construction, EXX, GW, and band calculations.
Added experimental head/wing corrections, including spin-polarized and two-dimensional dielectric workflows.
Added experimental auxiliary-basis and response compression, followed by screened-interaction unfolding.
Added QSGW backend and task infrastructure for future development. The QSGW task remained disabled in this release.
Introduced a regression-test backend with new ABACUS and FHI-aims cases, result comparisons, labels, and MPI smoke coverage.
Added new runtime controls, including minimax regulation and PyATB input selection.
Changed#
Updated the C++, C, and Fortran interfaces and their documentation for the spinor workflows.
Replaced the GPL Lebedev quadrature component with a local implementation under a compatible LGPL license.
Cleaned up obsolete code paths and third-party components.
Fixed#
Corrected spinor Green-function, response, EXX, self-energy, and quasiparticle calculations.
Fixed several distributed-matrix, MPI, input-reading, and non-LibRI build failures.
0.5.0 - 2026-03-28#
Added#
Added C/C++ and Fortran APIs for packed wavefunctions, band-path data, EXX band potentials, G0W0 self-energies, and quasiparticle energies.
Added atom-pair-to-BLACS and BLACS-to-atom-pair matrix redistribution with reusable index scheduling.
Added k-parallel Green-function construction and self-energy rotation for G0W0 calculations.
Added APIs for imaginary-frequency grids and dielectric-function input.
Added per-process profiling output and embedded Git reference information.
Changed#
Migrated the EXX and G0W0 driver tasks to the public API workflows.
Bundled LibRI and LibComm instead of requiring them as Git submodules.
Overhauled the installation, driver, API, tutorial, and reference documentation.
Improved OpenMPI and ScaLAPACK discovery and documented
SCALAPACK_DIR.
Fixed#
Corrected quasiparticle energies with multiple MPI tasks and without k-distributed eigenvectors.
Fixed failures when the MPI task count exceeded the number of atom pairs.
Fixed non-square process-grid handling and several Fortran-binding issues.
0.4.0-gw-benchmark - 2026-03-18#
This tag is the benchmark snapshot used for the LibRPA GW paper.
Added#
Added EXX and G0W0 band-structure workflows, including band-path input, k-grid quasiparticle energies, and KS/EXX/GW band output.
Added spectral-function calculations based on analytic continuation, with an optional imaginary-frequency shift.
Added automatic binary-format detection and readers for coefficient and Coulomb-matrix inputs.
Added a configurable driver input directory and general ELSI CSC matrix readers and writers.
Expanded regression coverage for atoms, molecules, and periodic solids.
Changed#
Reduced memory use in Green-function, response, screened-interaction, and self-energy calculations and improved their MPI/OpenMP scalability.
Optimized Fourier transforms, atom-pair redistribution, and coefficient and Coulomb-matrix input.
Adapted LibRPA to the updated LibRI RPA/GW interface.
Fixed#
Corrected EXX/GW basis rotations when the band and state counts differ.
Fixed band interpolation, distributed indexing, and small-system behavior with large MPI task counts.
Fixed multiple memory leaks and non-LibRI build regressions.
0.3.0 - 2024-11-22#
Added#
Added RPA correlation-energy, EXX, and initial G0W0 quasiparticle workflows, including analytic continuation and quasiparticle-equation solvers.
Added public C/C++ APIs and a Fortran binding for initializing LibRPA, supplying mean-field data, and retrieving RPA and EXX results.
Added ScaLAPACK two-dimensional block-matrix infrastructure and LibRI atom-pair routing with MPI/OpenMP parallelism.
Added binary coefficient input, real-space screened-interaction output, and driver runtime controls.
Added Sphinx and Doxygen documentation, GitHub Pages deployment, tutorials, and regression tests.
Changed#
Reorganized LibRPA into a shared library, driver, bindings, and tests.
Adopted CMake as the supported build system and added platform-specific build examples.
Integrated LibRI, LibComm, cereal, and GreenX time-frequency grids.
Fixed#
Corrected numerous response, RPA, EXX, GW, time-frequency transformation, and parallel-routing errors.
Fixed macOS builds, non-LibRI builds, output redirection, and binary-input behavior.
0.01 - 2024-04-16#
Initial tagged snapshot.
Added#
Added the initial standalone space-time response and RPA correlation-energy workflow with an FHI-aims file interface.
Added MPI/OpenMP execution, minimax time-frequency transformations, LibRI response construction, and ScaLAPACK-based RPA calculations.
Added CMake and Make build paths, runtime parameter parsing, profiling, regression cases, and initial continuous integration.
Fixed#
Corrected early Green-function, response, spin, and distributed RPA-energy calculations.