qlanth is a Wolfram/Mathematica paclet that can be used to calculate the level structure of lanthanide ions embedded in crystals. For this purpose, it uses a single configuration description (with configuration-interaction corrections) with the effective Hamiltonian shown below. This Hamiltonian describes the observed properties of ions embedded in solids in a picture that imagines them as free ions, modified by the influence of the lattice in which they are embedded.
This repository accompanies our publication:
Lizarazo Ferro, J. D., Puel, T. O., Flatté, M. E., & Zia, R. “Refining spectroscopic calculations for trivalent lanthanide ions: A revised parametric Hamiltonian and open-source solution.” Physical Review B 113, 075127 (2026).
Journal version: Physical Review B (2026)
arXiv version: arXiv:2503.17377
This picture is one that developed and mostly matured in the second half of the last century from the efforts of Brian Judd, Hannah Crosswhite, Michael Reid, Bill Carnall, Brian Wybourne, Katherine Rajnak, Douglas Newman, and several intrepid others. The goal of this code is to provide a modern implementation of the calculations that resulted from their work, with the aim of fixing some small errors that might have been included at the time these calculations were made. It also aims to provide useful electronic versions of the data these Hamiltonians may produce, including energies and eigenvectors.
qlanth also includes data that might be of use to those interested in the single-configuration description of lanthanide ions, independent of their specific use in this code. These data include the coefficients of fractional parentage (as calculated by Velkov and parsed here), and reduced matrix elements for all the operators listed above in the effective Hamiltonian. These are provided as standard Mathematica associations that should be simple to use elsewhere. In addition, qlanth also includes an implementation of Judd-Ofelt theory between levels and between individual states.
The /examples folder includes notebooks for several of the trivalent lanthanide ions in LaF₃, showing also comparisons against the published results of Carnall. LaF₃ (lanthanum trifluoride) is remarkable as one of the systems where a systematic study [Carnall (1989)] of most trivalent lanthanide ions was conducted.
The repository also includes a documentation file (qlanth.pdf) containing additional theoretical and practical details.
The folder /pyql includes Python versions of the symbolic arrays that represent the semi-empirical Hamiltonian in the different f configurations.
To install qlanth in Wolfram/Mathematica, use the following steps:
- Download the latest release and install the paclet using PacletInstall.
- See documentation therein. Probably going straight to
EffectiveHamiltonianandBasisLSJMJare the first things to try. The first function provides the matrix representation of the Hamiltonian for f^n, and the second function provides the labels for the ordered basis in which the representation is given.
To use the Python version of the resultant symbolic arrays, see the /pyql folder and the included scripts.
- Dodson, Christopher M., and Rashid Zia. “Magnetic Dipole and Electric Quadrupole Transitions in the Trivalent Lanthanide Series: Calculated Emission Rates and Oscillator Strengths.” Physical Review B 86, no. 12 (September 5, 2012): 125102. 🔗
- Velkov, Dobromir. “Multi-Electron Coefficients of Fractional Parentage for the p, d, and f Shells.” Johns Hopkins University, 2000. 🔗
- Nielson, C. W., and George F. Koster. "Spectroscopic Coefficients for the pn, dn, and fn Configurations, 1963. 🔗
- Wybourne, Brian. "Spectroscopic Properties of Rare Earths", 1965.
- Hansen, J. E., B. R. Judd, and Hannah Crosswhite. “Matrix Elements of Scalar Three-Electron Operators for the Atomic f-Shell.” Atomic Data and Nuclear Data Tables 62, no. 1 (1996): 1–49. 🔗
- Carnall, W. T., G. L. Goodman, K. Rajnak, and R. S. Rana. “A Systematic Analysis of the Spectra of the Lanthanides Doped into Single Crystal LaF₃.” The Journal of Chemical Physics 90, no. 7 (1989): 3443–57. 🔗
- Newman, DJ, and G Balasubramanian. “Parametrization of Rare-Earth Ion Transition Intensities.” Journal of Physics C: Solid State Physics 8, no. 1 (1975): 37. 🔗
- Judd, B. R. “Optical Absorption Intensities of Rare-Earth Ions.” Physical Review 127, no. 3 (August 1, 1962): 750–61. 🔗
If you use qlanth please cite as:
@article{lizarazopuel2026,
title = {Refining spectroscopic calculations for trivalent lanthanide ions: A revised parametric Hamiltonian and open-source solution},
author = {Lizarazo-Ferro, Juan David and
Puel, Tharnier O. and
Flatt{\'e}, Michael E. and
Zia, Rashid},
journal = {Physical Review B},
volume = {113},
pages = {075127},
year = {2026},
doi = {10.1103/llzb-wrlg},
url = {https://link.aps.org/doi/10.1103/llzb-wrlg}
}This project is licensed under the MIT License — see the LICENSE.md file for details.
-
This code was originally authored by Christopher Dodson and Rashid Zia. It was then rewritten, corrected in a few places, and expanded by David Lizarazo at Brown University around 2024. It has also benefited from the helpful discussions with Tharnier Puel at the University of Iowa.
-
qlanth was developed under a collaboration between the groups of Dr. Rashid Zia at Brown University, the Quantum Engineering Laboratory at the University of Pennsylvania led by Dr. Lee Bassett, and the group of Dr. Michael Flatté at the University of Iowa.
-
This work is supported by the National Science Foundation Grant No. DMR-1922025.