A license file from OpenEye Scientific Software is required to run any OpenEye application. A license file can be requested/obtained for any specific applications by contacting OpenEye at firstname.lastname@example.org.
At startup, the application looks for a valid license in the following default locations:
In a file specified by the environment variable
OE_LICENSE. Example commands to set the environment variable:
Linux/UNIX and MacOS:
setx OE_LICENSE C:\Users\USERNAME\oe_license.txtto set the environment variable permanently, or
SET OE_LICENSE=C:\Users\USERNAME\oe_license.txtto set for the duration of the cmd prompt.
$env:OE_LICENSE="C:\Users\USERNAME\oe_license.txt"is the syntax for PowerShell.
In a file named
oe_license.txtin the directory specified by the environment variable
In a file named
oe_license.txtin the user’s platform-specific local OpenEye application data directory. The location of this directory is detailed below:
In a file named
oe_license.txtin the current working directory
If a valid license is not found in one of the default locations, the user will be prompted to specify the location of the license file. The user may specify a local file, a file on a network/shared drive, or a network URL. If the specified file contains a valid license, the license file will be copied to a local cache so that it does not have to be found each time.
When the license file expires, a new license will automatically be searched for in the location that was specified for the current license. If a valid license is found in that location, it will automatically by copied over and used without any user action required. If a valid license file cannot be found, the user will again be prompted to locate one. When there are fewer than 30 days remaining on the current license, the application title bar will change to report the number of days remaining.
Once VIDA has started, the user can view the actual license file being used
(i.e. the locally cached copy), specify a new license file, or force an update
of the current license from the originally specified location. These options
can be accessed in the
License submenu of the main
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
PATH environment variable
Under the top-level
openeye directory are the following subdirectories:
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.
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.
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_ARCHcan be used to specify a colon separated list of compatible distributions for the current platform such as:
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_ARCHcan 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_ARCHas detailed above.
Specification of this environment variable overrides the
OE_ARCHenvironment 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_ARCHlist 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:
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.
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.
Specifying this argument followed by a specific version number allows the user to control which released version of the executable to run.
Windows distributions are provided as a standard MSI installer. Double click the installer and follow the instructions. For the OpenEye installation a data directory which contains example data for all of the application suites is installed by default. De-select it in the installer if you do not wish to install the data.
The OpenEye-applications folder will install into
C:\Program Files by default but can be overridden.
If Microsoft MPI is not installed on the system you must install this separately in order for the applications to run using multiple processes. You can download the MS-MPI installer, msmpisetup.exe, from here. See section MPI for more information.
Under the OpenEye-applications directory (
C:\Program Files\OpenEye-applications <version>) there are subdirectories for:
This directory contains the application executables.
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
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.
The Windows installer will automatically remove the last version of OpenEye-applications from the computer, if it exists, before installing the latest version of the software. To install older released versions of OpenEye-applications, you must first uninstall the latest version using
system settings\add or remove programs.
It is possible to perform a “silent installation” of the applications by running the
installer with the
/quiet flag from an administrator account.
It is also possible to run as a non-administrator, and to install to an alternate location from the default folder.
msiexec.exe /quiet /i OpenEye-applications-2019.May.1-win64-setup.msi When run from an administrator account this installs without displaying any progress or other istallation windows.
msiexec.exe /quiet /i OpenEye-applications-2019.May.1-win64-setup.msi ALLUSERS=2 MSIINSTALLPERUSER=1 INSTALL_ROOT=c:\mydir. Installs to
c:\mydir instead of the default location and can be run from a non-administrator account.
No reboot is required after installation.
macOS distributions are provided as a dmg disk image. For installation,
double click the .dmg file to open it, and copy 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.
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.
To uninstall a single distribution of a product the relevant subdirectories for that product and version simply need to be deleted from within the following directories:
openeye/archdirectory is a platform specific subdirectory. Within this are directories for each installed product and within those are subdirectories for each version of the product. Delete the subdirectory for the version which is to be uninstalled. For example, to delete or uninstall v1.0.0 of a product, delete the folder “<product_name>/1.0.0”.
openeye/datadirectory is a subdirectory for each installed product and within those are subdirectories for each version of the product. Delete the subdirectory for the version which is to be uninstalled.
OpenEye applications can be uninstalled through the Windows Control Panel. Open the Control Panel and select Programs and features, then select the application and click Uninstall.
For graphical applications, uninstallation also removes the application’s link from the desktop and Start menu.
Uninstallation of the OpenEye applications does not automatically uninstallation the MS-MPI, installated with the applications. To uninstall MS-MPI, you must follow the procedure through Windows Control Panel separately for MS-MPI.
To uninstall a single distribution of an application simply drag the application from the Application folder to the Trash.
Some applications may, at the user’s request, install symbolic links in the /usr/local/bin directory, and modify the PATH variable in the .openeyerc.* file(s) in the user’s home directory. The symbolic links may be safely deleted after uninstallation, and the .openeyerc.* file(s) can be edited, if desired, to remove obsolete entries.