Metadata-Version: 2.1
Name: cifkit
Version: 0.30
Summary: Python library for high-throuhgput .cif analysis
Author-email: Sangjoon Lee <bobleesj@gmail.com>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Keywords: cif,high-throughput,crystallography
Description-Content-Type: text/markdown
License-File: LICENSE

# cifkit

![logo-black](https://github.com/bobleesj/cifkit/assets/14892262/4ec3a308-35fd-43e5-8268-af261356ec9a)

- 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:

```bash
pip install -e .
```

## Developer

Sangjoon Bob Lee (@bobleesj)

### MkDocs

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