Skip to main content

genCF


A package to determine nonzero 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

$$ H_\text{CF} = \sum_{k=2,4,6}\sum_{q=0}^k \text{Re}\bigl[B^k_q\bigl] \left(C^{(k)}q + (-1)^q C^{(k)}{-q} +\right) + i,\text{Im}\bigl[B^k_q\bigl] \left(C^{(k)}q - (-1)^q C^{(k)}{-q}\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. As such, they have been denoted $A_{tp}$, following the notation used by Judd and Ofelt.

References

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.1.0.tar.gz (6.3 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.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gencf-0.1.0.tar.gz
Algorithm Hash digest
SHA256 26209d41225190b00dff0984e153afbff8a26f3a4d3eb97aa8500b3810c39167
MD5 9e3c38f9af7dcbb6bb528afb0bd4a625
BLAKE2b-256 730f5ee570d637485ce67349693a0aced0d3bd8ae8c5ecb98353523bed5d506c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gencf-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8847394430f60b855a4b357d2843ef84a0d67440785cf308488b263a99d84ea9
MD5 dad3bbcef69323bb97e60e79a382727f
BLAKE2b-256 802b9be6e80353610ce43c3309935f86debee3800544aa0741ae7d4218b69e5b

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

This release

0.1.0 This release

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