Metadata-Version: 2.4
Name: CIF2Dist
Version: 0.0.2
Summary: CIF2Dist is a python application to calculate the number and distance of coordination spheres of atoms in a lattice based on a cif.
Author-email: Marco Gurbisz and Tom Foerster <marco.gurbisz@hhu.de>
License: MIT
Project-URL: Homepage, https://github.com/morcubot/CIF2Dist
Project-URL: Repository, https://github.com/morcubot/CIF2Dist
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pymatgen
Dynamic: license-file

# CIF2Dist

**CIF2Dist** is a command-line tool and python package for calculating interatomic distances from a CIF (crystallography information file). It is authored by Marco Gurbisz and Tom Förster.

## Installation
For installation, clone the git repository and install the package locally:
```bash
git clone https://github.com/morcubot/CIF2Dist.git
cd CIF2Dist
pip install .
```
## Input
Input a CIF using its path and filename, and specify a site with -s to calculate the distance to its neighbors. This specification can be the Wyckoff site (e. g. '4a') or Wyckoff letter (e. g. 'a'), the site's name (e. g. 'Y1'), or the element (e. g. 'Y') if it is unambiguous (i .e there is only one site for this element). 
## Arguments
The tool supports multiple Arguments
### Center site --site, -s
Specifies center site for calculation. See Subsection 'Input'
### Cutoff Distance --cutoff, -c
Specifies cutoff distance for the calculation. The default value is 10 Ångstrom.
### Filter --filter, -f
Specifies the output filter. It accepts Wyckoff sites and letters, site labels and elements. The output will contain the specified site distances only.
## Output
 After running the code, you'll get an output file called 'summary.txt'. It contains the Site labels, the number of atoms on this site at the same distance and then the distance itself in Å all separated by a tab space character.
