Skip to content

Latest commit

 

History

History
128 lines (89 loc) · 6.42 KB

INSTALL.md

File metadata and controls

128 lines (89 loc) · 6.42 KB
Raw

Installing hpcviewer

Installing on MacOS

  1. If Java 17 or newer (Java 21 recommended) is not installed, install a recent Java from Adoptium (recommended):
  2. Download the HPCViewer binary package matching your architecture:
  3. Double-click the downloaded *.dmg file.
  4. Drag the hpcviewer.app icon to the "Applications" icon.
  5. Run hpcviewer.app from the Applications menu.

Installing on Windows

  1. If Java 17 or newer (Java 21 recommended) is not installed, install a recent Java from Adoptium (recommended):
  2. Download the HPCViewer binary package matching your architecture:
  3. Double-click the downloaded *.zip file to open it.
  4. Extract the hpcviewer folder inside to a local folder (e.g. Desktop).
  5. Run hpcviewer.exe in the extracted hpcviewer folder.

Installing on Linux (recommended for laptop/desktop)

  1. If Java 17 or newer (Java 21 recommended) is not installed, install a recent Java from Adoptium or via Spack.
  2. Download the HPCViewer binary package matching your architecture:
  3. Extract the downloaded tarball to a local directory: 
    $ tar xzf hpcviewer-linux.gtk.*.tgz
  4. Run the install script: 
    $ cd hpcviewer/
$ ./install /my/install/dir/  # e.g. ~/hpcviewer/
  5. Run /my/install/dir/hpcviewer, or add /my/install/dir to your PATH.

Installing via Spack (recommended for headless servers)

HPCViewer is available via Spack, simply run:

$ spack install hpcviewer
$ spack load hpcviewer

See the Spack User's Manual for instructions on how to set up Spack for your system and use it to install packages including HPCViewer.

Building HPCViewer from source

Build via command line (Maven)

On Posix-based platform with Bash shell (Linux and MacOS),

Run the build script from the project root:

$ ./build.sh

The script generates five hpcviewer-<release>-<platform>.[zip|tgz] files: Windows, Mac (x86_64 and Arm), and Linux (x86_64, ppcle64, and Arm).

  • For MacOS: unzip the appropriate .zip file for your platform and run the hpcviewer script contained inside.
  • For Linux: Follow the install instructions for Linux above with the appropriate .tgz file for your platform.

On Windows

Build directly with the Maven script:

$ mvnw.cmd clean package

This will compile and create hpcviewer packages for 4 platforms: Linux x86_64 and ppcle64, Windows and MacOS with Eclipse 4.30 (the default). Example of the output:

...
[INFO] Building zip: <hpcviewer.e4>/edu.rice.cs.hpcviewer.product/target/products/hpcviewer-win32.win32.x86_64.zip

Extract hpcviewer-win32.win32.x86_64.zip to a local folder, then run the hpcviewer.exe contained inside. (It is recommended to keep your development HPCViewer install separate from a release install.)

Building via Eclipse IDE

Requirements:

  • Recommended: Eclipse 2023.12 RCP or newer.
  • Warning: May not work properly with older versions of Eclipse.

Getting the source code into the Eclipse IDE

  • git clone https://gitlab.com/hpctoolkit/hpcviewer to your local system
  • Start Eclipse
  • Open the Import window via the menu File > Import
  • Select the import wizard General > Existing Projects into Workspace and click Next >
  • In Select root directory, select the directory where you have downloaded (the Git root)
  • In the Options section of the window, activate Search for nested projects
  • Click Finish

Activating the target plarform

To run hpcviewer, it requires Eclipse bundles and some external libraries such as Nebula NatTable, Eclipse Collections, JCraft and SLF4J. The set of bundles that are available is defined by the bundles in the Eclipse workspace, and additionally the bundles in the active target platform The first Eclipse starts after the installation, the target platform only includes the bundles that are installed in the workspace which doesn't include the external libraries.

The bundles that hpcviewer needs are defined in a custom target platform definition project, which is located in the target.platform directory:

  • Open file target-platform.target in target.platform project.
  • Click the "Set as Active Target Platform" link at the top-right panel.

Run the app

  • Open product configuration hpcviewer.product at edu.rice.cs.hpcviewer.product
  • To run: Click Launch an Eclipse application

Coding style

Recommended coding and formatting style: