Skip to content
A free, open-source Java library for modeling automata, graphs, and transition systems
Java Other
  1. Java 99.6%
  2. Other 0.4%
Branch: develop
Clone or download

Latest commit

Latest commit 230a58f Apr 4, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adapters [maven-release-plugin] prepare for next development iteration Feb 5, 2020
api [maven-release-plugin] prepare for next development iteration Feb 5, 2020
archetypes [maven-release-plugin] prepare for next development iteration Feb 5, 2020
build-parent Replace 3rd-party DOT Parser with own implementation Apr 4, 2020
build-tools Replace 3rd-party DOT Parser with own implementation Apr 4, 2020
commons Overhaul (de-)serialitation code Mar 14, 2020
core bound generic type remarked by checkerframework Mar 14, 2020
distribution [maven-release-plugin] prepare for next development iteration Feb 5, 2020
examples examples: replace sys.out with slf4j logging Feb 7, 2020
incremental
modelchecking [maven-release-plugin] prepare for next development iteration Feb 5, 2020
serialization Replace 3rd-party DOT Parser with own implementation Apr 4, 2020
src/site bump license header to 2020 Jan 6, 2020
util cleanup PMD exclusions Feb 7, 2020
visualization bump dependency version Feb 7, 2020
.appveyor.yml appveyor: bump JDK10 to JDK11 Jan 12, 2019
.gitattributes add .gitattributes Aug 19, 2018
.gitignore clean up .gitignores Aug 26, 2017
.travis.yml travis: also run site generation May 11, 2019
CHANGELOG.md Replace 3rd-party DOT Parser with own implementation Apr 4, 2020
LICENSE.txt fix typo in license file-name (see #16) Aug 28, 2017
README.md Update README.md Feb 5, 2020
pom.xml Replace 3rd-party DOT Parser with own implementation Apr 4, 2020

README.md

AutomataLib

Build Status Build Status Coverage Status Maven Central

AutomataLib is a free, open source (Apache License, v2.0) Java library for modeling automata, graphs, and transition systems.

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:

  • graph theory (traversal, shortest paths, strongly-connected components)
  • automata theory (equivalence, minimization)
  • model checking (adaptive distinguishing sequences, W(p)Method, characterizing sets, state/transition covers, LTL checking (via LTSMin))

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 or newer.

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

git clone -b develop --single-branch https://github.com/LearnLib/automatalib.git

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.

  • For IntelliJ IDEA:

    1. Select File -> New -> Project from existing sources and select the folder containing the development checkout.
    2. Choose "Import Project from external model", select "Maven" and click Next.
    3. Configure the project to your liking but make sure to check "Import Maven projects automatically" and have "Generated sources folders" set to "Detect automatically".
    4. Click Next until the project is imported (no Maven profile needs to be selected).
  • For Eclipse:

    1. 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).
    2. Select File -> Import... and select "Existing Maven Projects".
    3. Select the folder containing the development checkout as the root directory and click Finish.

Documentation

Mailing Lists

Maintainers

You can’t perform that action at this time.