API reference#
The API reference is organized by public objects rather than as a single member dump. Each class has an overview page, and callable methods have their own pages with the exact signature, parameter contract, and a short usage pattern. Tutorial calculations remain in the Getting started and Guided examples sections. Physical and numerical boundaries are documented separately in Limitations and scope.
Core calculation#
- HarmonicTransform
Transform the retained PETAL2D angular harmonics to momentum space and inspect or calibrate the numerical representation.
- Interaction
Assemble four-center matrix elements from two transformed transition fields, a radial kernel, and displacement vectors.
Convergence results#
- HarmonicConvergenceResult
Reusable result returned by
quartic2d.HarmonicTransform.converge_parameters().- InteractionConvergenceResult
Reusable result returned by
quartic2d.Interaction.converge_parameters().
Advanced numerical primitive#
- HankelTransform
One sampled radial Hankel transform. Most users should work through
quartic2d.HarmonicTransforminstead.