.. PySimpleAutomata documentation master file, created by
   sphinx-quickstart on Mon Feb 13 18:47:18 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PySimpleAutomata's documentation!
============================================

PySimpleAutomata
________________

.. Overview

PySimpleAutomata is a Python library to manage Deterministic Finite Automata (DFA),
Nondeterministic Finite Automata(NFA) and Alternate Finite state automata on Word (AFW).

This library is not meant for performance nor space consumption optimization,
but for academic purposes:
*PySimpleAutomata aims to be an easily readable but working representation of automata theory*.

.. Disclaimer

This project has been developed for "Process and Service Modelling and Analysis" class
of Master of Science in Engineering in Computer Science from Sapienza University of Rome.

.. Contacts

.. Report any bug through github issue section

.. References

.. Download

Offline versions of this documentation can be found `here <https://readthedocs.org/projects/pysimpleautomata/downloads/>`_

------------
Installation
------------

The project is **Python3 only**, tested on Python 3.5 and 3.6.

`Graphviz - Graph Visualization Software <http://graphviz.org//>`_
is required to be installed and present on system path to input/output DOT files.

From `PyPi <https://pypi.python.org/pypi>`_ using pip::

   pip install pysimpleautomata

From source::

    python setup.py install
    pip install -r requirements.txt

It is advised in any case to use a `Python Virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ instead of a global installation.

-------
Licence
-------

This code is provided under `MIT Licence <link to license file>`_.


Contents
========

.. toctree::
   :maxdepth: -1
   :includehidden:

   tutorial
   modules

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

* :ref:`Complete Index <genindex>`
* :ref:`modindex`
* :ref:`search`