Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 3.72 KB

README.md

File metadata and controls

98 lines (69 loc) · 3.72 KB

JGraLab

JGraLab is a Java graph library implementing so-called TGraphs: typed, attributed, ordered, and directed graphs. Beyond the plain data structure, the library contains an extensive algorithm library, the graph query language GReQL, the transformation API GReTL, and tons of utilities.

Current build status: Build Status

Installation and Building

Building from Sources

The jgralab project depends on the common project. It is important that they reside next to each other on your filesystem. For example, clone both projects into some base folder jgsrc so that the filesystem structure is like so.

jgsrc/               # your jgralab workspace
+-> jgralab/         # this project, i.e., jgralab itself

To build jgralab you need to have Apache Ant. Build jgralab.

$ cd jgsrc/jgralab/
$ ant

The jgralab project contains an Eclipse .project and .classpath file, so that you can import it in Eclipse as existing project.

Getting Releases via Maven or Leiningen

The current and past JGraLab releases are pushed to the JGraLab Clojars site so that you can fetch them easily as project dependency via the Maven or Leiningen build and project management systems.

Downloading a Pre-Compiled Jar

You can download nightly builds from our snapshots page. The source jars contain the compiled class files and the source files. As such, they are preferrable to the binary-only builds when you intend to develop applications using JGraLab, because then you get nicer code completion, e.g., the real names of method parameters instead of just arg0.

Documentation

API Documentation

You can find the API documentation for the current JGraLab master branch at our API Docs Page. This documentation is regenerated every night.

Coverage Report

Every night, we run all our test cases against the current master branch and measure our coverage using Atlassian Clover. The results are accessible at our Coverage Report Page.

Tutorials and Getting Started

We've started writing a tutorial in the JGraLab Wiki. It's not yet complete, but we'll keep working on extending it.

Getting Help

Join us on the official JGraLab IRC Channel (channel #jgralab on irc.freenode.net). If you don't have or don't want to install an IRC client, you can also chat directly in your browser.

License

Copyright (C) 2006-2013 The JGraLab Team [email protected]

Distributed under the General Public License (Version 3), with the following additional grant:

Additional permission under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or combining it
with Eclipse (or a modified version of that program or an Eclipse plugin),
containing parts covered by the terms of the Eclipse Public License (EPL),
the licensors of this Program grant you additional permission to convey the
resulting work.  Corresponding Source for a non-source form of such a
combination shall include the source code for the parts of JGraLab used as
well as that of the covered work.