README.md

AutomataLib

About

AutomataLib is developed at the Dortmund University of Technology, Germany.
Its original purpose is to serve as the automaton framework for the LearnLib active automata learning library.
However, it is completely independent of LearnLib and can be used for other projects as well.

AutomataLib supports modeling a variety of graph-based structures.
Currently, it covers generic transition systems, Deterministic Finite Automata (DFA) and Mealy machines as well as more advanced structures such as Visibly Pushdown Automata (VPDA).

Models of AutomataLib can be (de-)serialized (from) to one of the various supported serialization formats and may be visualized using either the GraphViz or JUNG library.
Furthermore, a plethora of graph-/automata-based algorithms is implemented, covering the following topics:

While we strive to deliver code at a high quality, please note, that there exist parts of the library that still need thorough testing.
Contributions -- whether it is in the form of new features, better documentation or tests -- are welcome.

Build Instructions

For simply using AutomataLib, you may use the Maven artifacts which are available in the Maven Central repository.
It is also possible to download a bundled distribution artifact, if you want to use AutomataLib without Maven support.
Note, that AutomataLib requires Java 8.

Building development versions

If you intend to use development versions of AutomataLib, you can either use the deployed SNAPSHOT artifacts from the continuous integration server (see Using Development Versions), or build them yourself. Simply clone the development branch of the repository

and run a single mvn clean install.
This will build all the required maven artifacts and will install them in your local Maven repository, so that you can reference them in other projects.

If you plan to use a development version of AutomataLib in an environment where no Maven support is available, simply run mvn clean package -Pbundles.
The respective JARs are then available under distribution/target/bundles.

Developing AutomataLib

For developing the code base of AutomataLib, it is suggested to use one of the major Java IDEs, which come with out-of-the-box Maven support.

Note: AutomataLib uses annotation processing on several occasions throughout the build process.
This is usually handled correctly by Maven, however, for Eclipse you need to install the m2e-apt-plugin and activate annotation processing afterwards (see the LearnLib issue #32).

Select File -> Import... and select "Existing Maven Projects".

Select the folder containing the development checkout as the root directory and click Finish.