Released: November 10, 2017
Written by Barak Naveh and Contributors
(C) Copyright 2003-2018, by Barak Naveh and Contributors. All rights reserved.
Please address all contributions, suggestions, and inquiries to the user mailing list
JGraphT is a free Java class library that provides mathematical graph-theory objects and algorithms. It runs on Java 2 Platform (requires JDK 1.8 or later starting with JGraphT 1.0.0).
JGraphT may be used under the terms of either the
- GNU Lesser General Public License (LGPL) 2.1 http://www.gnu.org/licenses/lgpl-2.1.html
or the
- Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php
As a recipient of JGraphT, you may choose which license to receive the code under.
For a detailed information on the dual license approach, see https://github.com/jgrapht/jgrapht/wiki/Relicensing.
A copy of the EPL license and the LPGL license is included in the download.
Please note that JGraphT is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Please refer to the license for details.
README.mdthis fileCONTRIBUTORS.mdlist of contributorsHISTORY.mdchangeloglicense-EPL.txtEclipse Public License 1.0license-LGPL.txtGNU Lesser General Public License 2.1javadoc/Javadoc documentationlib/JGraphT libraries:jgrapht-core-x.y.z.jarcore libraryjgrapht-demo-x.y.z.jardemo classesjgrapht-ext-x.y.z.jarextensionsjgrapht-ext-x.y.z-uber.jarall libraries rolled into onejgrapht-io-x.y.z.jarImporters/Exporters for various graph formatsjgrapht-io-x.y.z-uber.jarall libraries rolled into onejgraph-a.b.c.jarJGraph dependency libraryjgraphx-a.b.c.jarJGraphX dependency librarysource/complete source tree used to build this release
The package org.jgrapht.demo includes small demo applications to help you get started. If you spawn your own demo app and think others can use it, please send it to us and we will add it to that package.
To run the graph visualization demo from the downloaded release, try executing this command in the lib directory:
java -jar jgrapht-demo-x.y.z.jar
Starting from 0.9.0, every JGraphT release is published to the Maven Central Repository. You can add a dependency from your project as follows:
<groupId>org.jgrapht</groupId>
<artifactId>jgrapht-core</artifactId>
<version>1.1.0</version>
We have also started auto-publishing SNAPSHOT builds for every successful commit to master. To use the bleeding edge:
<groupId>org.jgrapht</groupId>
<artifactId>jgrapht-core</artifactId>
<version>1.1.1-SNAPSHOT</version>
and make sure the snapshot repository is enabled:
<repositories>
<repository>
<id>maven-snapshots</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
<layout>default</layout>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
To help upgrading, JGraphT maintains a one-version-backwards compatibility. While this compatibility is not a hard promise, it is generally respected. (This policy was not followed for the jump from 0.6.0 to 0.7.0 due to the pervasive changes required for generics.) You can upgrade via:
- The safe way : compile your app with the JGraphT version that immediately follows your existing version and follow the deprecation notes, if they exist, and modify your application accordingly. Then move to the next version, and on, until you're current.
- The fast way : go to the latest JGraphT right away - if it works, you're done.
Reading the change history is always recommended.
A local copy of the Javadoc HTML files is included in this distribution. The latest version of these files is also available on-line.
- JGraphT requires JDK 1.8 or later to build starting with version 1.0.0.
- JUnit is a unit testing framework. You need JUnit only if you want to run the unit tests. JUnit is licensed under the terms of the IBM Common Public License. The JUnit tests included with JGraphT have been created using JUnit
3.8.1. - XMLUnit extends JUnit with XML capabilities. You need XMLUnit only if you want to run the unit tests. XMLUnit is licensed under the terms of the BSD License.
- JGraph is a graph visualization and editing component. You need JGraph only if you want to create graph visualizations using the JGraphT-to-JGraph adapter. JGraph is licensed under the terms of the GNU Lesser General Public License (LGPL).
- JGraphX is the successor to JGraph. You need JGraphX only if you want to use the JGraphXAdapter to visualize the JGraphT graph interactively via JGraphX. JGraphX is licensed under the terms of the BSD license.
- Touchgraph is a graph visualization and layout component. You need Touchgraph only if you want to create graph visualizations using the JGraphT-to-Touchgraph converter. Touchgraph is licensed under the terms of an Apache-style License.
- ANTLR is a parser generator. It is used for reading text files containing graph representations, and is only required by the jgrapht-io module. ANTLR v4 is licensed under the terms of the BSD license.
The JGraphT website is at http://www.jgrapht.org. You can use this site to:
- Obtain the latest version: latest version and all previous versions of JGraphT are available online.
- Report bugs: if you have any comments, suggestions or bugs you want to report.
- Get support: if you have questions or need help with JGraphT.
There is also a wiki set up for everyone in the JGraphT community to share information about the project.
Source code is hosted on github. You can send contributions as pull requests there.
If you add improvements to JGraphT please send them to us as pull requests on github. We will add them to the next release so that everyone can enjoy them. You might also benefit from it: others may fix bugs in your source files or may continue to enhance them.
With regards from
Barak Naveh, JGraphT Project Creator
John Sichi, JGraphT Project Administrator
Joris Kinable, JGraphtT Project Reviewer/Committer and Release Manager
Dimitrios Michail, JGraphT Project Reviewer/Committer