bsym - A basic symmetry module
==============================

|DOI| |Build Status| |Test Coverage| |Documentation Status|

``bsym`` is a basic Python symmetry module for working with crystal symmetry operations.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started/index
   user_guide/index
   theory/index
   api/modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. |DOI| image:: https://zenodo.org/badge/19279643.svg
   :target: https://zenodo.org/badge/latestdoi/19279643
.. |Build Status| image:: https://github.com/bjmorgan/bsym/actions/workflows/build.yml/badge.svg
   :target: https://github.com/bjmorgan/bsym/actions/workflows/build.yml
.. |Test Coverage| image:: https://codeclimate.com/github/bjmorgan/bsym/badges/coverage.svg
   :target: https://codeclimate.com/github/bjmorgan/bsym/coverage
.. |Documentation Status| image:: https://readthedocs.org/projects/bsym/badge/?version=latest
   :target: http://bsym.readthedocs.io/en/latest/?badge=latest