Skip to content

Latest commit

 

History

History
151 lines (108 loc) · 5.53 KB

README.md

File metadata and controls

151 lines (108 loc) · 5.53 KB
Raw

Gephi Toolkit - All Gephi in one JAR library

Build Status

The Gephi Toolkit project packages essential Gephi modules (Graph, Layout, Filters, IO…) in a standard Java library which any Java project can use for getting things done. It can be used on a server or command-line tool to do the same things Gephi does, but automatically.

Use the toolkit

Find documentation and examples on the Toolkit Portal (out-of-date). It shows examples how to use the toolkit. Find more help on the forum, the community can help you.

From a Maven project

<dependency>
    <groupId>org.gephi</groupId>
    <artifactId>gephi-toolkit</artifactId>
    <version>0.9.2</version>
</dependency>

From a Gradle project

compile 'org.gephi:gephi-toolkit:0.9.2'

From a Scala SBT Project

resolvers ++= Seq(
  "NetBeans" at "http://bits.netbeans.org/nexus/content/groups/netbeans/",
  "gephi-thirdparty" at "https://raw.github.com/gephi/gephi/mvn-thirdparty-repo/"
)

libraryDependencies += "org.gephi" % "gephi-toolkit" % "0.9.2" classifier "all"

Latest releases

Stable

Nightly builds (0.9.3-SNAPSHOT)

Maven

If you have Maven you can directly depend on the latest development version of the toolkit (i.e the -SNAPSHOT version).

  • Add the Gephi repository
<project>
...
   <repositories>
      <repository>
         <id>oss-sonatype</id>
         <name>oss-sonatype</name>
         <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
         <snapshots>
            <enabled>true</enabled>
         </snapshots>
      </repository>
   </repositories>
...
</project>
  • Add the dependency
<project>
...
   <dependencies>
      <dependency>
         <groupId>org.gephi</groupId>
         <artifactId>gephi-toolkit</artifactId>
         <version>0.9.3-SNAPSHOT</version>
      </dependency>
      ...
   </dependencies>
...
</project>

Build

The Gephi Toolkit is entirely based on Gephi's source code and packages the core modules in a single JAR.

Requirements

Checkout and Build the sources

  • Fork the repository and clone

      git clone [email protected]:username/gephi-toolkit.git

  • Run the following command or open the project in Netbeans

      mvn clean install

Can the Toolkit use plugins?

Yes that is possible if the plug-in doesn’t depend on something not included in the Toolkit, for instance the UI. If that happens, it is likely that the plug-in has been divided in several modules, and in that case one need only the core and can exclude the UI. Consult this HowTo page to know how to extract the plugin JARs from the NBM file. Once you have the JARs, include them in your project’s classpath, in addition of the Gephi Toolkit.

License

Gephi main source code is distributed under the dual license CDDL 1.0 and GNU General Public License v3. Read the Legal FAQs to learn more.

Copyright 2011 Gephi Consortium. All rights reserved.

The contents of this file are subject to the terms of either the GNU General Public License Version 3 only ("GPL") or the Common Development and Distribution License("CDDL") (collectively, the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the License at http://gephi.org/about/legal/license-notice/ or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the specific language governing permissions and limitations under the License. When distributing the software, include this License Header Notice in each file and include the License files at /cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the License Header, with the fields enclosed by brackets [] replaced by your own identifying information: "Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL or only the GPL Version 3, indicate your decision by adding "[Contributor] elects to include this software in this distribution under the [CDDL or GPL Version 3] license." If you do not indicate a single choice of license, a recipient has the option to distribute your version of this file under either the CDDL, the GPL Version 3 or to extend the choice of license to its licensees as provided above. However, if you add GPL Version 3 code and therefore, elected the GPL Version 3 license, then the option applies only if the new code is made subject to such option by the copyright holder.