.. _crytomuseum: https://www.cryptomuseum.com/crypto/enigma
.. _CrypTool: https://www.cryptool.org/en/documentation/ctbook/
.. _networkx: https://networkx.org/

MzEnigma
===========================
A package implementing the operation of several enigma models (see `crytomuseum`_)
and common methods (see `CrypTool`_) for their analysis


Installing
----------

The package is a pure python package.
To work the package requires `networkx`_ for the manipulation of complex networks.

Download the package using
::

    pip install mzEnigma

    
Contents
-----------

.. toctree::
  :maxdepth: 3

  component
  enigma
  predefined
  analyzeEnigma

Indices and tables
-----------------------

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