Metadata-Version: 2.1
Name: structure2symmetry
Version: 0.0.1
Summary: A python package to extract symmetry information from structure files, including POSCAR, CIF, and other format supported by ase.io.read.
License: MIT
Author: Shibu Meher
Author-email: shibumeher@iisc.ac.in
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: ase (>=3.22.1,<4.0.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: spglib (>=2.3.1,<3.0.0)
Description-Content-Type: text/markdown

# structure2symmetry

This small python code uses Atomic Simulation Environment and spglib to determine the symmetry information from a structure file like POSCAR, CIF and many more supported by ase.io.read(refer to https://wiki.fysik.dtu.dk/ase/ase/io/io.html).

## Installation

Using `pip`, use the following command to install

`pip install structure2symmetry`

Using the source code

```
git clone https://github.com/Shibu778/structure2symmetry.git
cd structure2symmetry
pip install -e .
```

## Use

You can use following commandline interface to get symmetry information from a structure file.

```
struct2symm --filepath "./SiC.cif" --tolerance 1e-6 --angle_tolerance 0.01 --destination "./" --savefile "data.info"
```

