Skip to main content

genCF


A package to determine non-vanishing crystal field parameters from point group symmetries.

Installation

To install genCF using PyPI, run the following command:

pip install gencf

Example Usage

>>> from gencf import generate_allowed_terms, print_allowed_terms

>>> C3v = generate_allowed_terms('C3v')
>>> print_allowed_terms(C3v)
+-----+---------------+-------------------+
|   k | Real Terms    | Imaginary Terms   |
+=====+===============+===================+
|   1 | A10           | —                 |
+-----+---------------+-------------------+
|   2 | B20           | —                 |
+-----+---------------+-------------------+
|   3 | A33, A30      | —                 |
+-----+---------------+-------------------+
|   4 | B43, B40      | —                 |
+-----+---------------+-------------------+
|   5 | A53, A50      | —                 |
+-----+---------------+-------------------+
|   6 | B66, B63, B60 | —                 |
+-----+---------------+-------------------+
|   7 | A76, A73, A70 | —                 |
+-----+---------------+-------------------+

Theory

The crystal field Hamiltonian can be written as [1, 2]

$\displaystyle H_\text{CF} = \sum_{k=2,4,6}\sum_{q=0}^k \text{Re}\bigl[B^k_q\bigr] \left(C_{q}^{(k)} + (-1)^q C_{-q}^{(k)} \right) + i\text{Im}\bigl[B^k_q\bigr] \left(C_{q}^{(k)} - (-1)^q C_{-q}^{(k)}\right).$

Depending on the site symmetry of the crystal, certain components of the crystal field parameters, or the entire parameter will vanish.

The crystal field parameters for odd $k$ do not contribute to the energy splitting between $4f$ energy levels due to parity of the $4f$ eigenstates, but they are relevant when modelling the electric dipole transition [3, 4, 5]. As such, they have been denoted $A_{tp}$, following the notation used by Judd and Ofelt [4, 5].

Further reading can be found in the references.

Notes

  • The $z$-axis is taken as the axis of highest symmetry.
  • The $xz$-plane is taken to be the $\sigma_v$ symmetry plane to make $\text{Im}(B^k_q)$ vanish [6].
  • Point groups that do not contain $\sigma_v$ symmetry can be rotated about the $z$-axis to remove the imaginary component from ONE of the $B^k_q$ terms for $q \neq 0$ [6].
    • NOTE: this has not been performed in the code
  • The five cubic point groups $T, T_h, T_d, O, O_h$ were too difficult to calculate, so the non-vanishing crystal field parameters have been quoted from [1, 2, 7].

References

[1] G. Liu, Spectroscopic Properties of Rare Earths in Optical Materials, 1st ed (Springer Berlin / Heidelberg, Berlin, Heidelberg, 2005).

[2] D. J. Newman and B. Ng, editors , Crystal Field Handbook, Digitally printed version (Cambridge Univ. Press, Cambridge, 2007).

[3] M. F. Reid and F. S. Richardson, Electric dipole intensity parameters for lanthanide 4 f → 4 f transitions, The Journal of Chemical Physics 79, 5735 (1983).

[4] G. S. Ofelt, Intensities of Crystal Spectra of Rare-Earth Ions, The Journal of Chemical Physics 37, 511 (1962).

[5] B. R. Judd, Optical Absorption Intensities of Rare-Earth Ions, Phys. Rev. 127, 750 (1962).

[6] J. W. Leech and D. J. Newman, How to Use Groups, Repr (Chapman and Hall, London, 1977).

[7] J.-D. Lizarazo-Ferro, T. O. Puel, M. E. Flatté, and R. Zia, Refining spectroscopic calculations for trivalent lanthanide ions: A revised parametric Hamiltonian and open-source solution, Phys. Rev. B 113, 075127 (2026).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gencf-0.2.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gencf-0.2.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file gencf-0.2.0.tar.gz.

File metadata

  • Download URL: gencf-0.2.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.4

File hashes

Hashes for gencf-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d40ef0c96dd8d7a4e2dc4b02156e2d8cde14b965a7041b676cf3b59965d96e16
MD5 ceb01ad99e2d4a380c2d7b31209b0d8b
BLAKE2b-256 7c0ed4317ff304f85fef4f55518b2605ea7be50964f6a691c8cfbe800c8f0853

See more details on using hashes here.

File details

Details for the file gencf-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gencf-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.4

File hashes

Hashes for gencf-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c76a567bed1b37ae3638a5e52a9f28e1720d6c3316a14ede9728bff9da2fe27
MD5 6b32a5b6b7b558daa311f573da02d7d6
BLAKE2b-256 27e71e8d366b928f907badb8b628094723c38b086e91b5d6e18f20fae5253d06

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.1

2 files

This release

0.2.0 This release

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page