Installation

Installing via pip

PolyCleaver can be simply installed via pip:

pip install polycleaver

Cloning the repository

If you want to get the absolutely latest version you can clone the repo:

git clone https://github.com/ericmates/PolyCleaver.git

and then install PolyCleaver via:

cd PolyCleaver
python3 setup.py install --user

in the root directory. This will set up PolyCleaver as a Python module.

Requirements

PolyCleaver requires Python3 and depends on the following libraries

• pymatgen (structure handling)

• NumPy (numerical linear algebra)