PGX 2.3.1
Documentation

Installation

The following instructions will allow you to get started quickly with PGX and to analyze graphs directly on your local machine. More advanced usage models, which include running PGX as a server, can be found at the end of this section.

System Requirements

  • Java SE 8 Development Kit (JDK8)
  • [Optional] To run PGX in distributed execution mode, each machine of the target cluster must have the C++ standard libraries built upon 3.4.20 of the GNU C++ API installed. In order to install those libraries,
  • [Optional] Some distributions of PGX also support dynamic compilation of Green-Marl code at runtime. To use that feature, you'll need a Linux x86 (kernel >= 2.6) or Mac OS X operating system with clang installed. Examples of such systems include, but are not limited to:
    • Oracle Linux Server (x86) Release 6.5
    • Ubuntu (x86) 12.0.4.4 LTS
    • Ubuntu (x86) 14.04.1 LTS
    • Mint (x86) 17.1
    • ArchLinux (x86) 2011.08.19
    • Mac OS X (x86) 10.10.5

Basic Server Installation

  1. Install the Oracle JDK 8, if it is not already on your system. Refer to your system administrator, or follow these instructions to install:

    • Download Java SE 8 Development Kit (JDK8) from here .
    • Follow the installation instructions located above.
    • Make sure the JAVA_HOME environment variable points to the JDK8 home directory, e.g. export JAVA_HOME=/usr/lib/jvm/java-8-oracle.
  2. Download the PGX server package

  3. Unpack the downloaded zip file into a directory of your choice. For example, unzip pgx-2.3.1-server.zip -d /opt/pgx.

  4. cd into the installation directory. Verify PGX boots up by starting the PGX Shell:

    cd $PGX_HOME
    ./bin/pgx
    

See our troubleshooting section if you encounter problems.


Directory Structure

  • bin - PGX executables
  • conf - PGX configuration files
  • distributed - PGX distributed server binaries (multiple machine deployment)
  • examples - Example code (Java, Green-Marl) and example graph data
  • shared-memory - PGX shared-memory server binaries (single machine deployment)
  • yarn - libraries for Hadoop YARN deployment

Advanced use cases

Start a PGX Server

Read in the following tutorials how to start the PGX server in shared memory mode (single machine, scale up) or distributed mode (multiple machines, scale out):

Start the PGX shared memory server Start the PGX distributed server

PGX on Hadoop

PGX also supports HDFS and runs on YARN. Details for these can be found in these tutorials:

Load from and store to HDFS Run PGX as YARN application

Deploy PGX as Servlet Web Application

You can also run shared memory PGX inside of a web application. PGX ships with a WAR-file which can be deployed directly into your favorite servlet container:

Deploy PGX into Weblogic Deploy PGX into Jetty Deploy PGX into Tomcat

PGX Client

Do you already have a PGX server running? Refer to this tutorial to learn how to connect to a server:

Connect to a running PGX server