Skip to main content

About pycf

pycf is a collection of Python modules for crystal field theory and spin Hamiltonian calculations. It provides tools for setting up and fitting energy levels of rare-earth ions using crystal-field Hamiltonians, as well as utilities for working with spin Hamiltonians and transition intensities. The core library is implemented in C99 for performance, with Python/Cython wrappers for ease of use.

Status and Quality

CI Status Python Version Tests Passing

For detailed installation instructions, see INSTALL.md.

Branches

  • main — recommended for users who want stability. Updated when a development cycle reaches a tagged release.

  • devel — current integration branch. Track this if you want to follow ongoing work and try features before they land on main; expect occasional breakage.

  • Feature branches (feat/...) — in-progress work, opened for review via pull requests. Comment on them if you want to influence a feature before it merges into devel.

  • legacy — mirrors Sebastian Horvath’s original Bitbucket repository (https://bitbucket.org/sebastianhorvath/pycf/). Provided for historical reference; not actively developed.

By default git clone checks out main; pass -b devel (or git checkout devel after cloning) to follow the development branch.

Quick Start (Development)

git clone https://github.com/mikereidnz/pycf.git
cd pycf
python3 -m venv env
source env/bin/activate
pip install -e ".[test,examples]"
python -m pytest tests/ -q

Project Structure

  • cfl/ — C99 core library for setting up and fitting Hamiltonians.

  • pycf/ — Python/Cython wrappers

  • examples/ — End-to-end workflows for real materials

  • tests/ — Python and C unit tests

Documentation

  • INSTALL.md — Installation guide with platform-specific instructions

  • docs/legacy/ — Legacy technical documentation preserved for reference

  • examples/ — Material-specific usage examples

Authorship

Originally developed by Sebastian Horvath (sebastian.horvath@gmail.com). Currently maintained by Mike Reid (mike.reid@canterbury.ac.nz).

A legacy version is available at https://bitbucket.org/sebastianhorvath/pycf/ and also on the “legacy” branch of this repository.

License

GNU General Public License v3 (GPLv3)

Metadata

Release files for pycf-crystalfield 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycf-crystalfield 0.2.1
File Size Uploaded Provenance Actions
pycf_crystalfield-0.2.1.tar.gz 3.5 MB Without provenance Details for pycf_crystalfield-0.2.1.tar.gz

Release files / pycf_crystalfield-0.2.1.tar.gz

Download URL pycf_crystalfield-0.2.1.tar.gz
Size 3.5 MB
Tags Source
SHA-256 checksum
How to use checksums
d506289387dd2219c9d429ebceefcb388c272bf5d8613a96c7528ffc3c2bcad1
BLAKE2b-256 checksum
How to use checksums
b5e7345a98e59c0325fb9cbfbda6c0beeeafa4ee505cb79fd653cfcc1af0062f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for pycf-crystalfield 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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