Skip to main content

Python library for high-throuhgput .cif analysis

Project description

cifkit

logo-black

  • preprocess .cif files for high-throuhgput processing
  • move, copy, filter files based on a comprehensive set of attributes such as coordination number, elements, tags
  • determine nearest neighbor and coordination environments at each site
  • facilitate the plotting of polyhedrons and

Overview

cifkit provides two primary objects: Cif and CifEnsemble.

  • Cif: Initializes with a .cif file path. It parses the .cif file, preprocesses ill-formatted files, generates supercells, and computes nearest neighbors. It also determines coordination numbers using four different methods and generates polyhedrons for each site.

  • CifEnsemble: Initializes with a folder path containing .cif files. It identifies unique attributes, such as space groups and elements, across the .cif files, moves and copies files based on these attributes. It generates histograms for all attribute.

Motivation

  • High throughput analysis tools using .cif files for research. The tools analyze bonding distances, site analysis, and coordination numbers.
  • Each tool requires preprocesing, formatting, copying, moving, and sorting .cif files.
  • To streamline the above tasks, I developed cifkit that can be easily imported for the above tasks.

Documentation

Please see the tutorial provided here (TBA).

Installation

To run locally:

pip install -e .

Developer

Sangjoon Bob Lee (@bobleesj)

MkDocs

pip install mkdocstrings
pip install mkdocstrings-python
pip install mkdocs
pip install mkdocs-material
pip install mkdocs-jupyter
mkdocs serve

Project details


Download files

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

Source Distribution

cifkit-0.30.tar.gz (44.7 kB view details)

Uploaded Source

Built Distribution

cifkit-0.30-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

Details for the file cifkit-0.30.tar.gz.

File metadata

  • Download URL: cifkit-0.30.tar.gz
  • Upload date:
  • Size: 44.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for cifkit-0.30.tar.gz
Algorithm Hash digest
SHA256 d168e8f29764060e053a16f3a6292f25e6719d5789a8632c7f002a5c183356d7
MD5 6dff241fa0d302e38cc6fab46f4f1c0a
BLAKE2b-256 8cd6c8ad760ff898a355e92b46ea638eb67d80f9eda755d68e9d28cb911fdb7f

See more details on using hashes here.

File details

Details for the file cifkit-0.30-py3-none-any.whl.

File metadata

  • Download URL: cifkit-0.30-py3-none-any.whl
  • Upload date:
  • Size: 77.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for cifkit-0.30-py3-none-any.whl
Algorithm Hash digest
SHA256 b92b754c0482d5d8617c183782eb551b23f611ae1e59ad15b5cdbf85165dde0e
MD5 4ec70b28829d7dfda9a3583a851569d9
BLAKE2b-256 0efa5fb5fd8f721461720ac89ad8f4a1f08363d956d0e4fb54b8686d49087644

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page