1[![Version Badge](https://anaconda.org/conda-forge/spglib/badges/version.svg)](https://anaconda.org/conda-forge/spglib) 2[![Downloads Badge](https://anaconda.org/conda-forge/spglib/badges/downloads.svg)](https://anaconda.org/conda-forge/spglib) 3[![PyPI](https://img.shields.io/pypi/dm/spglib.svg?maxAge=2592000)](https://pypi.python.org/pypi/spglib) 4 5# Spglib 6 7C library for finding and handling crystal symmetries 8 9## How to compile with cmake 10 11``` 12% mkdir _build 13% cd _build 14% cmake .. 15% make 16% make install (probably installed under /usr/local) 17``` 18 19Or to install under /some/where 20 21``` 22% mkdir _build 23% cd _build 24% cmake -DCMAKE_INSTALL_PREFIX="" .. 25% make 26% make DESTDIR=/some/where install 27``` 28 29A simple test is executed by 30 31``` 32% make check 33``` 34 35## How to run test 36 37Test is provided with the python interface. 38``` 39% cd python 40% pip install -e . 41% pytest 42``` 43 44## Development 45 46The development of spglib is managed on the `develop` branch of github spglib repository. 47 48* Github issues is the place to discuss about spglib issues. 49* Github pull request is the place to request merging source code. 50 51## Documentation 52 53Spglib user documetation is written using python sphinx. The source files are stored in `doc` directory. Please see how to write the documentation at `doc/README.md`. 54 55## Mailing list for questions 56 57Usual spglib questions should be sent to spglib mailing list (https://sourceforge.net/p/spglib/mailman/). 58