.. _shakenbreak_module:

ShakeNBreak Package
===================

See the `doped DeepWiki <https://deepwiki.com/SMTG-Bham/ShakeNBreak/1-overview>`__ site for an overview of the
codebase and workflow diagrams.

Module contents
---------------
 .. automodule:: shakenbreak
     :members:
     :undoc-members:
     :show-inheritance:

Submodules
----------

.. toctree::

  shakenbreak.input
  shakenbreak.distortions
  shakenbreak.io
  shakenbreak.analysis
  shakenbreak.plotting
  shakenbreak.energy_lowering_distortions
  shakenbreak.cli