Installation

Linux

Linux distributions are provided as a gzipped tarball of the distribution tree described below. Installation is performed by simply untarring the file in the desired location. The top-level directory in the tarball is named openeye. Distributions for different Linux variants can be installed into the same location, allowing multiple Linux versions to be run from a single shared directory.

To ensure that the installed applications can be called from the command line, be sure to add the full path of the openeye/bin subdirectory to the PATH environment variable. For instance, if the distribution was installed into /usr/local/openeye, the PATH environment variable should contain: /usr/local/openeye/bin.

Under the top-level openeye directory are the following subdirectories:

arch:This directory contains the collection of platform specific subdirectories. Each subdirectory contains the actual installed executables and support libraries for the associated platform. In the platform specific subdirectory there will be a subdirectory for each application. Within that will be another subdirectory for each version of that application.
bin:This directory contains a startup script for each application that has been installed. This script determines, at run-time, what the current platform is and then calls the appropriate executable in the arch. This script enables the easy co-existence of multiple platforms and versions of any OpenEye application in the same distribution tree.
data:This directory contains all of the associated data and examples for the installed applications. There will be a subdirectory for each installed application and within that subdirectory there will be another subdirectory for each specific version of that application.

The startup script discussed in the section on the bin directory above will have the same name as the installed executable with which it is associated. When the script is called, it will attempt to determine the current platform and run the appropriate executable if installed. If an appropriate executable cannot be found, the script will report that information, as well as a list of the currently installed platforms. The auto-detection can be overridden by setting one of two environment variables:

  • OE_ARCH can be used to specify a colon separated list of compatible distributions for the current platform such as:

    redhat-RHEL7-x64:redhat-RHEL6-x64

    or Ubuntu-16.04-x64:Ubuntu-14.04-x64

    Specification of this environment variable overrides the auto-detection process, if it is present. If none of the compatible distributions listed are found, the script will fall back to the auto-detection process.

  • APPNAME_OE_ARCH can be used to specify a colon separated list of compatible distributions for a specific application (as specified by changing the APPNAME text in the environment variable name) just like OE_ARCH as detailed above.

    Specification of this environment variable overrides the OE_ARCH environment variable as well as the auto-detection process. If none of the compatible distributions listed are found, the script will fall back to the OE_ARCH list first and then to the auto-detection process.

    Specifying this variable provides a simple way to customize the behavior for individual applications on non-standard platforms.

The startup script also supports a few commandline arguments including:

-path Specifying this argument will output the full path of the executable to be run. The executable will not be started if this argument is present.
-print_arch Specifying this argument will output the details of the current platform as detected by the script as well as which platform-version of the executable is being run. The executable will be started if this argument is present.
-use_version Specifying this argument followed by a specific version number allows the user to control which released version of the executable to run.

Windows

Windows distributions are provided as a standard EXE installer. For installation double click the executable and follow the installation instructions. By default, a data directory which contains example data for all of the application suites is installed. De-select it in the installer if you do not wish to install the data. The OpenEye-applications folder will install into the C:\Program Files by default but can be overridden. The installer will also provide the user to optionally install Microsoft’s implementation of MPI which is required by the applications. See section MPI for more information.

../_images/windows_install2.png ../_images/win_install_mpi.png
Optionally Select Data MPI Install prompt

Under the OpenEye-applications directory (C:\Program Files\OpenEye-applications <version>) there are subdirectories for:

bin:This directory contains the application executables.
data:This directory contains all of the associated data and examples for the installed applications.

An OpenEye-applications group will be added to the Start menu. It will contain a link to an OpenEye command shell with PATH settings already defined to allow the user to simply type the executable name at the prompt without concern for where the executable is actually installed. A shortcut to the OpenEye command shell will also be placed onto the Desktop. Links to graphical apps and an OpenEye-applications Data folder will also be installed to the Start menu and Desktop.

Enterprise Installation for Windows

It is possible to perform a “silent installation” of the applications by running the installer with the /S flag. During a silent installation, no progress or other installation windows will be displayed. If this flag is used, the installer should be run from an administrative account to avoid the appearance of a “User Account Control” dialog during installation. No reboot is required after installation.

macOS

macOS distributions are provided as a dmg disk image. For installation, double click the .dmg file to open it, and drag each application to the Applications folder. For convenience multiple items to install can be selected at once by drawing a box around them or by using command-click on each item.

Task Screen

macOS disk image

A folder named OpenEye-applications<version#> Data containing all the associated data for the applications is included in the disk image. It can be dragged to the Applications folder or other convenient location for installation.

An application named “Install Command Line Support” can be run from the .dmg file which will allow the user to add the command-line applications’ location to the user’s PATH environment variable. Command-line applications can also be run from the Applications folder, in which case they will open a terminal window with a properly configured environment. The user may need to source their ~/.profile file after executing “Install Command Line Support” to update the PATH in existing terminals.