Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.65 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.65 KB
Raw

GraphStream

Build Status

The GraphStream project is a java library that provides an API to model, analyze and visualize graphs and dynamic graphs.

Check out the Website http://www.graphstream-project.org/ for more information.

Installing GraphStream

The release comes with a pre-packaged jar file named gs-core.jar that contains the GraphStream classes. To start using GraphStream, simply put it in your class path. You can download GraphStream on the github releases pages, or on the website http://www.graphstream-project.org/.

Maven users may include major releases of gs-core as a dependency:

<dependencies>
    <dependency>
        <groupId>org.graphstream</groupId>
        <artifactId>gs-core</artifactId>
        <version>2.0</version>
    </dependency>
</dependencies>

Development Versions

Using https://jitpack.io one can also use any development version. Simply add the jitpack repository to the pom.xml of the project:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

then, add the gs-core to your dependencies:

<dependencies>
    <dependency>
        <groupId>com.github.graphstream</groupId>
        <artifactId>gs-core</artifactId>
        <version>dev-SNAPSHOT</version>
    </dependency>
</dependencies>

You can use any version of gs-core you need. Simply specify the desired version in the <version> tag. The version can be a git tag name (e.g. 2.0), a commit number, or a branch name followed by -SNAPSHOT (e.g. dev-SNAPSHOT). More details on the possible versions on jitpack.

User interface

gs-core does not ship any default user interface anymore. In order to display graphs, one need a GraphStream viewer (mainly gs-ui-javafx or gs-ui-swing). These are the steps to get a viewer:

  1. Download a GraphStream viewer and add the jar to your classpath (or as a dependency to pom.xml, for maven users).
  2. Set a system property to tell gs-core which viewer to use :
         System.setProperty("org.graphstream.ui", "javafx");
  1. Enjoy Graph.display() as usual.

Help

You may check the documentation on the website http://www.graphstream-project.org/. You may also share your questions on the mailing list at http://sympa.litislab.fr/sympa/subscribe/graphstream-users.

License

See the COPYING file.