bsym - A basic symmetry module

DOI Build Status Test Coverage Documentation Status

bsym is a basic Python symmetry module. It consists of core classes that describe configuration vector spaces, their symmetry operations, and specific configurations of objects withing these spaces. The module also contains an interface for working with pymatgen Structure objects, to allow simple generation of disordered symmetry-inequivalent structures from a symmetric parent crystal structure.

API documentation is here.

Examples are provided in a Jupyter notebook here

Source code is available as a git repository at


Automated testing of the latest commit happens here.

Manual tests can be run using

python -m unittest discover

The code has been tested with Python versions 3.5 and above.

Indices and tables