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.1.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.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gencf-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2340b5761d330cc6ca5a0d6ea3368d9f09781442fb4436e9cdda2752bd9771df
MD5 04f9018e12d4f1e5c94cd685a2a88ebc
BLAKE2b-256 d6e0c39bb52a4d6ca553e741595f121a2431408339a4663ee1c5d72fc35a1b5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gencf-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5acf1c30b9a3b8390b0e557a0aefe83c77261b692ed61f6f4b4b4ab9eef922a4
MD5 cd1e21ad66c5ea9aa1fcb65909f1e2f7
BLAKE2b-256 89bd1ea2afb13e2b5058eca6b68985eea9c87d6d5ae5e4ecb7b1862de6ca1525

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.1

2 files

0.2.0

2 files

This release

0.1.1 This release

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