Installing the software

Windows

  1. Be sure you have a recent Java JRE installed on your system. Download Free Java here.
  2. After the download completes, run the installer and follow the steps.

Mac OS X

  1. The application needs Java SE 6, which may not be enabled by default. See this install page for Leopard. If you have Lion or Mountain Lion, you need to install Java first.
  2. After the download completes, click on the downloaded .dmg file.
  3. Drag the gephi application in your Application folder.

Linux

  1. Update your distribution with the last official JRE packages (update 25+), don’t use OpenJDK.
  2. After the download completes, unzip and untar the file in a directory.
  3. Run it by executing ./bin/gephi script file.

Ubuntu users: Install Sun Java via Synaptic, do a Quick Search Search for “sun java” and install the jre and jdk. Do not forget to run update-alternatives –config java and update-alternatives –config javac.
If you’re on the 8.10 version, please install Java manually from the Oracle website, because the distributed packages are obsolete.
ArchLinux users: a community package is available here.

Troubleshooting

JVM Creation failed

This error message is due to memory settings, see following section.

Memory

Memory available to Gephi is determined by Java. Less or more memory can be allocated by configuring Gephi’s startup settings. If too less memory is allocated, Gephi will stop running when it reached the limit and you will loose your current work. If too much memory is set, Java will not be able to start and return “JVM Creation failed” message. By default, maximum memory is set to 256mo or 512mo.

To modify memory settings, you need to edit gephi settings file. Modify the value after the -Xmx option to change the maximum heap space. For example, to use a heap size between 256 and 1024 MB, change the options to -Xms256m and -Xmx1024m. If you have Gephi open, you must close and reopen Gephi before new options take effect. On computers with 2GB of memory, you can set -Xmx1400 to get maximum performance.

How to edit gephi.conf:

  • On Windows, go to the Gephi folder in Start menu and click on Startup Settings. Edit this file with Notepad or WordPad. Alternatively, go in C:\Program Files\Gephi\etc\gephi.conf and edit file manually.
  • On Mac OS X, right-click on Gephi application icon and select Show Package Contents to open a new Finder window displaying a Contents folder. Open the Contents folder, and then open the Resources/gephi/etc folder, in which the gephi.conf file resides. Use TextEdit to edit the file.
  • On Linux, go into your application directory and then into the etc folder. Edit the file with a text editor.

To use Gephi with more than ~1.5GB of memory, which could happen with large graphs, you need to use A 64-bit version of Java. See following section.

64-bit

Gephi has been successfully tested on 64-bit architecture (AMD64, Intel Core 2 Duo, Intel Core i7), 64 bits OS (Windows Vista 64-bit, Windows 7 64-bit) and 64-bit version of Java (JVM 64-Bit Server). To use more than ~1.5GB of memory in Gephi, which could happen with large graphs, you need to have a 64-bit architecture, OS and a 64-bit JVM. A compatible 64-bit JRE or JDK can be downloaded from the Java website.

When multiple JRE or JDK are installed on the same machine, you can specifty to Gephi to use a particular path. Edit gephi.conf as  described in the upper section, uncomment the jdkhome line and set the JRE or JDK path.

Linux JRE Path

If you still have the wrong Java package running after following the linux installation procedure described above, then manually set the Java virtual machine. To do so, you have to set the home folder of the desired JVM in the environment variable JAVA_HOME or in the environment variable JDK_HOME.

User files

Locate and delete gephi user directory to clean your installation.

  • On Windows 2K/XP, user diretory is located in C:\Documents and Settings\username\Application Data\.gephi
  • On Windows Vista/Seven, user directory is located in C:\Users\username\AppData\Roaming\.gephi
  • On Mac OS X, user directory is located in /Users/username/Library/Application Support/gephi
  • On Linux, user diretory is located in /home/username/.gephi

OpenJDK

OpenJDK is not supported, be sure to run the official Java 6 version from Oracle’s website.

Gephi may be able to start with OpenJDK but the graph window will fail to load in most cases.