How to build Gephi

Kyle Brooks edited this page Mar 16, 2016 · 3 revisions
Clone this wiki locally

Because Gephi is built on top of the Netbeans Platform, all development needs to take place in Netbeans IDE, which fully integrates all tools for Netbeans Platform developers.

Introduction

Netbeans Platform

The NetBeans Platform is a generic framework for Swing applications. It provides the "plumbing" that, before, every developer had to write themselves—saving state, connecting actions to menu items, toolbar items and keyboard shortcuts; window management, and so on.

Gephi Architecture

Gephi software architecture is modular and therefore each feature is split into modules. Modules depend on each other, similar to Java packages. Plugins developers simply create new modules that contains their code, add dependencies to Gephi modules, and distribute their plugins by creating an NBM package. See Gephi APIs documentation to learn more about the API plugins that can be used by modules.

image

Building Gephi

Requirements

  • Java JDK 7 or 8 with preferably Oracle Java JDK.
  • Apache Maven version 3.2.2 or later
  • Latest Version of NetBeans

Checkout and Build the sources

Navigate to the desired directory you wish to place the project via terminal, then clone the repository:

>> git clone https://github.com/gephi/gephi

Install Gephi via Maven:

Mac/Linux/Windows:

>> cd gephi 
>> mvn clean install

Note: This process could take some time.

That's it. Once built, Gephi can be run via the following commands:

Mac/Linux:

>> cd modules/application
>> mvn nbm:cluster-app nbm:run-platform

Windows:

>> cd modules\application
>> mvn nbm:cluster-app nbm:run-platform

Building Gephi in NetBeans

To develop with Gephi, you need to use the same Netbeans version as the current source code. The latest Netbeans stable released is used by default. However, you also need to update your Netbeans installation to latest updates. To check if Netbeans is up to date, go to Help > Check for Updates in Netbeans menu. If asked to installed JUnit, click Yes.

Note: Always update Netbeans with Administrator privileges.

Check for Updates

From here, click File > Open Project in the Netbeans menu and navigate to the Gephi file folder. Click it, then click Open Project. Ensure the checkbox "Open Required Projects" is not selected. Once this is done, you will be able to work with/edit Gephi files in Netbeans.

Opening Gephi

To run Gephi with changes, select Run > Clean and Build from the Netbeans menu. Next, in the Projects tab of the file navigator, select Gephi > Modules > gephi-app nbm-application and select Run > Project from the Netbeans menu.

Build/Run Gephi

Troubleshooting

Build error: Cannot compile against a module

C:\Program Files (x86)\NetBeans 6.8\harness\build.xml:165: Cannot compile against a module: C:\Program Files (x86)\NetBeans 6.8\platform11\lib\org-openide-util.jar because of dependency: org.openide.util > 7.31.2.1 BUILD FAILED (total time: 23 seconds)

Netbeans has not been correctly updated because updates were not run with Administrator Privileges. Reinstall Netbeans and perform updates again to fix this issue.

No dependent module org.netbeans.libs.junit4

The JUnit plugin need to be installed in Netbeans. Go to Tools > Plugins and install JUnit plugin.

Since Netbeans 7.0, the JUnit module is not installed by default, but available as a Plugin. Netbeans will propose to install the JUnit either during installation or when opening the Gephi project.