Skip to content

Latest commit

 

History

History
454 lines (367 loc) · 23.7 KB

README.md

File metadata and controls

454 lines (367 loc) · 23.7 KB
Raw

Galaxy: an asynchronous distributed parallel framework

master: Build Status dev: Build Status

Galaxy is an asynchronous parallel visualization framework for ray-based operations, including ray tracing, sampling and volume integration. Galaxy has been designed for performance in distributed computing environments, including in situ use. Galaxy builds upon Intel OSPRay and Intel Embree and includes ray queueing and sending logic inspired by TACC GraviT.

Galaxy has been developed primarily by Greg Abram and Paul Navratil with funding from the US Department of Energy's Office of Science ASCR program (Drs. Lucy Nowell and Laura Biven, program managers) through sub-award from Los Alamos National Laboratory; from Intel Corporation through Intel Parallel Computing Center awards; and from the Texas Advanced Computing Center at the University of Texas at Austin. A full list of contributors can be found in the CONTRIBUTORS file.

Galaxy is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. A copy of the License is included with this software in the file LICENSE. If your copy does not contain the License, you may obtain a copy of the License at: Apache License Version 2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2014-2020 The University of Texas at Austin. All rights reserved.

Galaxy dependencies

Galaxy has two types of dependencies: (1) components assumed to be already installed in an accessible spot; and (2) components that are associated with the Galaxy repository in the third-party subdirectory.

Galaxy assumes the following are already installed on your system in an accessible spot (these should all be available via package manager for your OS):

Galaxy has the following components associated in the third-party subdirectory:

NOTE: the third-party component locations are intended for development builds of Galaxy. If you intend to install Galaxy for general use, you should install Embree, OSPRay and rapidjson into a generally-accessible location and use those locations in the Galaxy build.

Installing Galaxy associated dependencies

Prior to building Galaxy itself, you should ensure that all the general dependencies are installed (we recommend your humble OS package manager). Once those are in place, you're ready to install the dependencies in third-party. There are two steps to this process: 1) downloading and patching the submodules, and 2) building and installing the submodules.

Scripted build

We recommend using the Galaxy-provided build script scripts/install-third-party.sh, which will configure and build all submodules with a single command (if this script does not work for your configuration, please open a GitHub issue). If you need to customize your build, please see the next section.

To download and build the submodules: cd to the root directory of your local Galaxy repository and run the script ./scripts/install-third-party.sh, which will (1) init and update the git submodules, (2) download ispc to where Galaxy expects to find it, and (3) build each in a build subdirectory and install into an install subdirectory. This script will populate the third-party/ispc, third-party/embree, third-party/ospray, and third-pary/rapidjson subdirectories. Once built, each third-party component will be installed to a single centralized location in third-party/install.

Custom build

The third-party dependency build can also be done by hand, for example, to specify custom software locations or to change the configuration of Embree or OSPRay. Note that even with a custom build, the submodules still should be patched as described below.

To download and patch the submodules: cd to the root directory of your local Galaxy repository and run the script ./scripts/prep-third-party.sh, which will (1) init and update the git submodules, and (2) download ispc to where Galaxy expects to find it. This script will populate the third-party/ispc, third-party/embree, third-party/ospray, and third-pary/rapidjson subdirectories.

To build and install the submodules, do the following in third-party/embree, then third-part/ospray, then third-party/rapidjson (third-party/ispc is already installed via the script):

mkdir build
cd build
cmake <cmake flags> .. && make && make install

NOTE: for the CMake flags used for each third-party library, see the CMAKE_FLAGS variables defined in scripts/install-third-party.sh.

Local installs of Galaxy associated dependencies

If you prefer to use local installs of any of the dependencies, you can follow instructions below. Make sure to issue git submodule init <path> and git submodule update <path> for the third-party dependencies you do NOT have locally installed. For example, to use the rapidjson submodule, type:

git submodule init third-party/rapidjson
git submodule update third-party/rapidjson

ISPC

The third-party/ispc directory contains a script to download a recent ISPC binary for MacOS or Linux. ISPC installed using this script should be detected automatically by the Galaxy CMake configuration. If you already have a recent ISPC installed (at least version 1.9.1) you are free to use it, though you might need to specify its location by hand in the CMake configurations for Embree, OSPRay, and Galaxy.

From the root directory of your Galaxy repository, issue the following commands:

cd third-party/ispc
./get-ispc.sh

This will download ISPC (currently version 1.12.0) into third-party/ispc/ispc-v<version>-<OS type> (e.g., ispc-v1.10.0-macOS), and it will install the ispc executable in third-party/install/bin. If this binary does not work on your system, you will need to build ISPC by hand following the directions at the ISPC website.

Embree

After updating the git submodules as described above, the third-party/embree directory should contain the Embree source tree. We recommend building in third-party/embree/build and installing to third-party/install, as doing so should enable Galaxy to find Embree. The recommended install directory is configured as part of the Embree cmake flags in scripts/install-third-party.sh.

First, create a build directory and build Embree. Assuming CMake can find all required dependencies, you can use the cmake command to configure the makefile for the Embree build:

mkdir build
cd build
cmake <cmake flags> .. && make && make install

If cmake complains about missing dependencies, you can specify or change their locations using cmake -D<CMAKE VAR> command-line syntax or using the interactive ccmake interface with ccmake .. in the build directory. See scripts/install-third-party.sh for recommended cmake flags.

OSPRay

Before installing OSPRay, make sure you have updated the Galaxy git submodules and successfully built Embree, as described above. Once the git submodules have been updated, the third-party/ospray directory should contain the OSPRay source tree. We recommend building in third-party/ospray/build and installing to third-party/install, as doing so should enable Galaxy to find OSPRay automatically. The recommended install directory is configured as part of the OSPRay cmake flags in scripts/install-third-party.sh.

First, create a build directory and build OSPRay. Assuming CMake can find all required dependencies, you can use the cmake command to configure the makefile for the OSPRay build:

mkdir build
cd build
cmake <cmake flags> .. && make && make install

If cmake complains about missing dependencies, you can specify or change their locations using cmake -D<CMAKE VAR> command-line syntax or using the interactive ccmake interface with ccmake .. in the build directory. See scripts/install-third-party.sh for recommended cmake flags.

rapidjson

Before installing rapidjson, make sure you have updated the Galaxy git submodules as described above. Once the git submodules have been updated, the third-party/rapidjson directory should contain the rapidjson source tree. We recommend building in third-party/rapidjson/build and installing to third-party/install, as doing so should enable Galaxy to find rapidjson automatically. The recommended install directory is configured as part of the RapidJSON cmake flags in scripts/install-third-party.sh.

First, create a build directory and build rapidjson. Assuming CMake can find all required dependencies, you can use the cmake command to configure the makefile for the rapidjson build:

mkdir build
cd build
cmake <cmake flags> .. && make && make install

If cmake complains about missing dependencies, you can specify or change their locations using cmake -D<CMAKE VAR> command-line syntax or using the interactive ccmake interface with ccmake .. in the build directory. See scripts/install-third-party.sh for recommended cmake flags.

Building Galaxy

Before building Galaxy, make sure all assumed and third-party subdirectory dependencies have been installed as described above, which will allow the Galaxy CMake configuration to find all dependencies automatically. We recommend building in <Galaxy root>/build and installing to <Galaxy root>/install. The recommended install directory is configured as part of the Galaxy CMake configuration.

Assuming CMake can find all required dependencies, you can use the cmake command to configure the makefile for the Galaxy build:

mkdir build
cd build
cmake .. && make && make install

If cmake complains about missing dependencies, you can specify or change their locations using cmake -D<CMAKE VAR> command-line syntax or using the interactive ccmake interface with ccmake ...

Running Galaxy

There are several ways to run Galaxy. In this document we currently only describe the batch mode applications; interactive viewers will be added to the documentation as time allows.

Setting up the environment

In the install root, galaxy.env contains the necessary environment variable settings for running Galaxy. If you use the bash or sh shells, you can 'source' that file; for csh you'll need to modify it.

We currently assume that your environment has been set up to find both VTK and Intel OSPRay libraries.

Preparing test data

mkdir $PROJECT/test
cd $PROJECT/test

Make some volumetric test data

radial -r 256 256 256

will create a .VTI dataset (radial-0.vti - note that radial will create timestep data if requested and the '-0' reflects the timestep) with several variables: ramps in X, Y and Z; oneBall is f(x, y, z) = mag(x, y, z) and eightBalls is f(x, y, z) = mag(abs(x) - 0.5, abs(y) - 0.5, abs(z) - 0.5) We can create native format datasets:

vti2vol radial-0.vti oneBall eightBalls

will create radial-0-oneBall.vol, radial-0-eightBalls.vol and corresponding …raw files that actually contain the data as bricks of floats.

Sample Galaxy State File

Galaxy uses a JSON state file format to describe data and visualization operations. We discuss a sample Galaxy configuraiton file below. For more details about Galaxy state files, see docs/state_files.md.

The following is a state file that should work with the datasets we created above, and will result in six renderings: two visualizations rendered from each of the three cameras.

{
    "Datasets":
    [
      {
        "name": "oneBall",
        "type": "Volume",
        "filename": "radial-0-oneBall.vol"
      },
      {
        "name": "eightBalls",
        "type": "Volume",
        "filename": "radial-0-eightBalls.vol"
      }
    ],
    "Renderer": {
        "Lighting": {
          "Sources": [[1, 1, 0, 1]],
          "shadows": true,
          "Ka": 0.4,
          "Kd": 0.6,
          "ao count": 16,
          "ao radius": 0.5
      }
    },
    "Visualizations":
    [
      {
        "annotation": "",
        "operators":
          [
            {
              "type": "Volume",
              "dataset": "oneBall",
              "isovalues": [ 0.25 ],
              "volume rendering": false,
              "colormap": [
                [0.00,1.0,0.5,0.5],
                [0.25,0.5,1.0,0.5],
                [0.50,0.5,0.5,1.0],
                [0.75,1.0,1.0,0.5],
                [1.00,1.0,0.5,1.0]
               ],
              "slices": [ [1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0] ],
              "opacitymap": [
                [ 0.00, 0.05],
                [ 0.20, 0.05],
                [ 0.21, 0.00],
                [ 1.00, 0.00]
               ]
            }
          ]
      },
      {
        "annotation": "",
        "operators":
          [
            {
              "type": "Volume",
              "dataset": "eightBalls",
              "slices": [ [1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0] ],
              "volume rendering": true,
              "colormap": [
                [0.00,1.0,0.5,0.5],
                [0.25,0.5,1.0,0.5],
                [0.50,0.5,0.5,1.0],
                [0.75,1.0,1.0,0.5],
                [1.00,1.0,0.5,1.0]
               ],
              "opacitymap": [
                [ 0.00, 0.05],
                [ 0.20, 0.05],
                [ 0.21, 0.00],
                [ 1.00, 0.00]
               ]
            }
          ]
       }
    ],
    "Cameras":
    [
      {
        "aov": 30,
        "Xaov": 20,
        "viewpoint": [1, 2, -3],
        "viewcenter": [0, 0, 0],
        "viewup": [0, 1, 0]
      },
      {
        "aov": 30,
        "Xaov": 20,
        "viewpoint": [2, 1, -3],
        "viewcenter": [0, 0, 0],
        "viewup": [0, 1, 0]
      },
      {
        "aov": 30,
        "Xaov": 20,
        "viewpoint": [3, 1, -2],
        "viewcenter": [0, 0, 0],
        "viewup": [0, 1, 0]
      }

    ]
}

Considering each section in turn:

The Datasets section define the datasets that are available for visualization. Each dataset specification includes the means to access the data, either using a file name or the information necessary to attach to an external source of data, and a name to be used internally.

The Renderer section includes the properties of the rendering, which are currently common among all the results of the run. Rendering properties currently are simply the lighting model to be used, including the light sources themselves, whether to cast shadow rays or to add a fixed proportion of diffuse lighting, and whether to cast AO rays or to add a fixed proportion of ambient light.

The Visualizations section is an array, where each element (a visualization) contains an array of operators: one or more datasets and properties to be included in the visualization. As an example, if the following is an element in a visualization operator array, that array will include the eightBalls dataset, with one slice, one isovalue and with volume rendering using the given transfer function.

{
    "type": "Volume",
    "dataset": "eightBalls",
    "volume rendering": true,
    "slices": [ [0, 0, 1, 0] ],
    "isovalues": [ 0.05 ],
    "colormap": [
            [0.00,1.0,0.5,0.5],
            [0.25,0.5,1.0,0.5],
            [0.50,0.5,0.5,1.0],
            [0.75,1.0,1.0,0.5],
            [1.00,1.0,0.5,1.0]
           ],
    "opacitymap": [
            [ 0.00, 0.05],
            [ 0.20, 0.02],
            [ 0.21, 0.00],
            [ 1.00, 0.00]
           ]
}

Finally, the Cameras section is also an array, consisting of the cameras to be used. Cameras are very simply specified.

Interactive Viewing

Interactive mode, where images are displayed in a client viewer, is the default Galaxy CMake configuration (i.e. GXY_WRITE_IMAGES is off).

A visualization consists of a specification of one or more datasets to appear in the visualization, along with the properties of each - the slicing planes, isovalues, transfer functions, radii etc. The Galaxy viewer will use the first camera and visualization specified in the configuratin file. The Galaxy writer will produce images for the complete cross-product of cameras and visualizations (see below).

If you cut’n’paste the complete state file above into a text file named radial.json in the test directory, you can run:

[mpirun mpiargs] gxyviewer [-s width height] radial.json

Batch Mode Image Writing

Batch mode, where images are written to file without an interactive viewer, relies on a state file to define one or more visualizations and one or more cameras. Batch mode is activated by turning on GXY_WRITE_IMAGES in the Galaxy CMake configuration.

A visualization consists of a specification of one or more datasets to appear in the visualization, along with the properties of each - the slicing planes, isovalues, transfer functions, radii etc.
The result of the state file is the cross product of the sets of visualizations and cameras: a rendering of each visualization from every camera will be produced.

If you cut’n’paste the complete state file above into a text file named radial.json in the test directory, you can run:

[mpirun mpiargs] gxywriter [-s width height] radial.json

You will produce three output .png files.

Cinema

Cinema17 databases are built in batch mode, and thus from a batch file that contains arrays of visualizations and cameras. This file may contain many visualizations; for example, if the the Cinema database has a varying isovalue and a moving slicing plane, there will be a separate visualization for each combination of isosurface value and slicing plane position. Ten isovalues and ten slicing plane positions lead to 100 unique visualizations. Similarly, the batch file may contain many cameras, one for each desired viewpoint. To make the creation of such batch files simple, the cinema.json file specifies a single visualization and camera parametrically.

Note: Galaxy currently creates spec C Cinema databases. You must download the Cinema viewer, the browser-based viewer requires spec D format

The following shows an example cinema.json:

{
    "Datasets":
    [
      {
        "name": "oneBall",
        "type": "Volume",
        "filename": "oneBall-0.vol"
      },
      {
        "name": "eightBalls",
        "type": "Volume",
        "filename": "eightBalls-0.vol"
      }
    ],
    "Renderer": {
        "Lighting": {
          "Sources": [[0, 0, -4]],
          "shadows": true,
          "Ka": 0.2,
          "Kd": 0.8,
          "ao count": 0,
          "ao radius": 0.1
      }
    },
    "Visualization":
    [
      {
        "type": "Isosurface",
        "dataset": "eightBalls",
        "isovalue range": { "min": 0.3, "max": 1.3, "count": 10 },
        "colormap": "eightBalls_cmap.json",
        "opacitymap": "eightBalls_omap.json"
      },
      {
        "type": "Slice",
        "dataset": "oneBall",
        "plane range":
        {
          "w": { "min": -0.9, "max": 0.9, "count": 10 },
          "normal": [0.0, 0.0, 1.0]
        },
        "colormap": "oneBall_cmap.json"
      },
      {
        "type": "Volume Rendering",
        "dataset": "eightBalls",
        "colormap": "eightBalls_cmap.json",
        "opacitymap": "eightBalls_omap.json"
       }
    ],
    "Camera":
    {
      "viewpoint": [3, 0, -4],
      "viewcenter": [0, 0, 0],
      "viewup": [0, 1, 0],
      "theta angle": { "min": -0.5, "max": 0.5, "count": 2 },
      "phi angle": { "min": -0.5, "max": 0.5, "count": 2 },
      "aov": 30
    }
}

In this example, we see a single “Visualization” element, rather than the array of visualizations given in a state file. This, though, parametrically defines a set of 100 visualizations, consisting of the cross product of 10 isovalues and 10 offsets of a slicing plane (which varies from -1 to 1 based on the range of the intersection of the normal ray with the object bounding box. Similarly, a single parametric camera is given as a base view defined by a viewpoint and view center, but varying the azimuth and elevation in a range (in radians). This defines 4 cameras, and, with 100 visualizations, will create a Cinema database of 400 images.

Note, also, that the colormaps and opacity maps can be given as file names.

Given such a cinema.json file, the included Python script cinema2state will expand the parametric cinema specification to an explicit batch file, and prepare a Cinema database. If the above is in cinema.json, the corresponding Cinema database can be created by:

cinema2state cinema.json

which will create state.json and initialize cinema.cdb. Following this,

[mpirun mpiargs] cinema [-s width height] -C state.json

will render the necessary images and deposit them into cinema.cdb.

Galaxy Notes

Performance and a note on threading

This renderer is parallel both by using multiple processes over MPI and by threading within each process. Both the generation of initial rays and the processing of rays is now multithreaded. By default, only a single thread is used, but the GXY_NTHREADS environment variable can be used to increase the number of worker threads.

On my Mac Powerbook (2.8 GHz 4 core), the above Cinema database requires 579 seconds to render at 500x500 resolution. Using GXY_NTHREADS=8 (the activity monitor indicates there are 8 virtual cores - hyperthreading?) reduces rendering time to 156 seconds.

Galaxy environment variables

The following environment variables affect Galaxy behavior:

  • GXY_NTHREADS : use the requested number of threads in the rendering thread pool (default 1)
  • GXY_APP_NTHREADS : use the requested number of threads for the application (default TBB default)
  • GXY_FULLWINDOW : render using the full window
  • GXY_PERMUTE_PIXELS : vary the order in which pixels are processed (can improve image quality under camera movement)
  • GXY_RAYS_PER_PACKET : The number of rays to include in a transmission packet (default 10000000)
  • GXY_RAYDEBUG : turn on ray debug pathway, taking GXY_X, GXY_Y, GXY_XMIN, GXY_XMAX, GXY_YMIN, GXY_YMAX from environment variables
  • GXY_X : x coordinate for single-ray debug (requires GXY_RAYDEBUG)
  • GXY_Y : y coordinate for single-ray debug (requires GXY_RAYDEBUG)
  • GXY_XMIN : lower x extent for debug window (requires GXY_RAYDEBUG)
  • GXY_XMAX : upper x extent for debug window (requires GXY_RAYDEBUG)
  • GXY_YMIN : lower y extent for debug window (requires GXY_RAYDEBUG)
  • GXY_YMAX : upper y extent for debug window (requires GXY_RAYDEBUG)