Difference between revisions of "Getting ICE"

Latest revision as of 09:00, 2 February 2017

This page describes the process by which users can download and use the binary version of ICE. We recommend most users use the binary, however, for those who are adventurous at heart, detailed instructions on building ICE from the source code are available on the ICE Build Instructions page.

ICE requires the Java Development Kit version 8 to build and run.

Installing ICE from Binaries

Downloading ICE

ICE binaries are now available on the ICE website: https://www.eclipse.org/ice/. From the main menu, select Downloads and then choose the desired binaries (stable nightly builds or unstable nightly builds). Upon selection, the user will be taken to a mirror site to download the binary for their operating system.

The user should select the appropriate binary for their application. In the naming scheme ice-*-2.X.Y.zip.zip, * is the operating system and processor architecture, and X and Y are the major and minor version numbers.

For example, ice-win32-x86-2.2.0.zip would be the appropriate choice for 64-bit Windows, and ice-linux-gtk-x86_64-2.X.Y.zip would be the appropriate choice for 64-bit Red Hat Enterprise Linux 6 (RHEL6). The table below shows the available binaries and their respective operating systems.

Binary version	Operating System
ice-win32-x86_64-2.X.Y.zip	64-bit versions of Windows, including most installations of Windows Vista, 7 and 8
ice-win32-x86-2.X.Y.zip	32-bit versions of Windows, including most installations of Windows XP
ice-macosx-cocoa-x86_64-2.X.Y.zip	64-bit Mac, including most OS X installations (10.4.7 "Tiger" and newer)
ice-linux-gtk-x86_64-2.X.Y.zip	64-bit Linux running GTK (most flavors of Linux)
ice-linux-gtk-x86-2.X.Y.zip	32-bit Linux running GTK

The binary distributions are fully-functional, full-featured, executable versions of ICE that include everything except for the Java Virtual Machine, third-party libraries, and plug-ins that are currently in development. If you have any questions, please contact us at eclipse.ice.project <at> gmail <dot> com or join one of our mailing lists.

Prerequisites

ICE requires a Java Development Kit (JDK) with Java 1.8 or greater. Sun's version of Java can be used on Linux, Windows, or Mac, and OpenJDK can also be used on Linux and Mac. The ICE development team prefers OpenJDK for Linux systems. Some tools in ICE also require the installation of third-party libraries. While it is not necessary to install these libraries to run ICE, the Reactors and Visualization perspectives will not work correctly without them.

For Mac OS X users, ICE developers also recommend installing the Homebrew package manager.

VisIt (Optional)

To visualize 3D data, ICE requires the installation of VisIt (minimum version 2.8.2) on a local or remote machine.

VisIt is available for download from the Lawrence Livermore National Laboratory website, and doesn't require any additional configuration to use with ICE.

ParaView (Optional)

As an alternative to VisIt, ICE is also capable of using ParaView instead, also on either a local or remote machine.

ParaView is available for download from the official ParaView website, and also doesn't require any additional configuration to use with ICE.

3D Graphics

ICE also requires that your system has 3D rendering enabled to edit geometries and visualize 3D data, which is normally done by installing the 3D graphics drivers from the vendor of your graphics card. You should consult your IT specialist if you do not know how to enable this feature on your machine.

Certain features in ICE, currently including the Geometry and Mesh editors, also require JavaFX. This is included in most versions of the JDK, but default distributions for some Linux operating systems (including Fedora and CentOS) do not. In that case, you will need to download the official nightly build from the Java website. Then in the terminal, run

alternatives --install /usr/bin/java java /path/to/the/jdk installation/jre/bin/java 3

or some number other than 3 if you already have multiple jdk installations. Then run

alternatives --config java

And type in the number you assigned to the new JDK in the previous step.

Running ICE

Once you download the appropriate zip file for your operating system, extract it to a directory of your choice. No additional installation steps are required because ICE is executed directly from this directory.

Windows: In the file browser, navigate to the folder where you extracted ICE. In the ICE folder, double-click ICE.exe. On Linux and Mac systems, you may follow the same procedure, but the ICE executable is only called ICE on those systems.

Mac OS: You may get a message that says that ICE is from an unidentified developer and cannot be opened. Workaround: in the file browser right-click (or control-click) the ICE executable, click Open in the context menu, and then click OK when prompted again. Alternatively, ICE may be executed from the command line on Linux and Mac systems.

Linux: ICE may be executed from the command line on Linux systems by navigating to the folder where ICE was extracted, and then issuing the command ./ICE.

When ICE is executed, it will display data and debug information in the console window as the environment runs. You may safely ignore this window while you are working by keeping it minimized or in the background.

What if ICE fails to run?

If you feel you've followed all the above directions for configuring ICE and its dependencies, and ICE still fails to run, email us directly at ice-dev <at> eclipse.org. If you believe that you have identified a bug, please report it to our GitHub bug tracker.

@@ Line 1: / Line 1: @@
-This page describes the process by which users can download and use ICE. Detailed instructions on building ICE are available on the [Compiling ICE From Scratch page](Compiling ICE From Scratch).
+This page describes the process by which users can download and use the binary version of ICE. We recommend most users use the binary, however, for those who are adventurous at heart, detailed instructions on building ICE from the source code are available on the [[ICE Build Instructions]] page.
-**Table of Contents**
+{{note|ICE requires the Java Development Kit version 8 to build and run.}}
-[TOC]
+== Installing ICE from Binaries ==
-## Prerequisites
+=== Downloading ICE ===
-ICE requires Java 1.6 or greater. Sun's version of Java can be used on Linux, Windows or Mac and the OpenJDK can also be used Linux and Mac. The ICE Development Team prefers the OpenJDK on Linux systems.
+ICE binaries are now available on the ICE website: https://www.eclipse.org/ice/. From the main menu, select ''Downloads'' and then choose the desired binaries (stable nightly builds or unstable nightly builds). Upon selection, the user will be taken to a mirror site to download the binary for their operating system.
-ICE should work out-of-the-box with no problems if the following third party libraries are installed to their default locations. See the "tips and tricks" section for dealing with custom install locations.
+The user should select the appropriate binary for their application. In the naming scheme ''ice-*-2.X.Y.zip.zip'', '''*''' is the operating system and processor architecture, and ''X'' and ''Y'' are the major and minor version numbers.
-### Sample Data
+For example, ''ice-win32-x86-2.2.0.zip'' would be the appropriate choice for 64-bit Windows, and ''ice-linux-gtk-x86_64-2.X.Y.zip'' would be the appropriate choice for 64-bit  Red Hat Enterprise Linux 6 (RHEL6). The table below shows the available binaries and their respective operating systems.
-If you want to download some sample data to play around with different features of ICE, it is available [here]().
+{| class="wikitable" style="text-align:left;"
+|-
+! width="250px" |'''Binary version'''
+! | '''Operating System'''
+|-
+| ice-win32-x86_64-2.X.Y.zip
+|  64-bit versions of Windows, including most installations of Windows Vista, 7 and 8
+|-
+| ice-win32-x86-2.X.Y.zip
+| 32-bit versions of Windows, including most installations of Windows XP
+|-
+| ice-macosx-cocoa-x86_64-2.X.Y.zip
+| 64-bit Mac, including most OS X installations (10.4.7 "Tiger" and newer)
+|-
+| ice-linux-gtk-x86_64-2.X.Y.zip
+| 64-bit Linux running GTK (most flavors of Linux)
+|-
+| ice-linux-gtk-x86-2.X.Y.zip
+| 32-bit Linux running GTK
+|}
-### VisIt
+The binary distributions are fully-functional, full-featured, executable versions of ICE that include everything except for the Java Virtual Machine, third-party libraries, and plug-ins that are currently in development. If you have any questions, please contact us at '''<tt>eclipse.ice.project <at> gmail <dot> com</tt>''' or join one of [[ICE_Mailing_Lists | our mailing lists]].
-[VisIt](https://wci.llnl.gov/codes/visit/) is an optional requirement for those who want to use the Reactor Analysis Tool, which requires VisIt 2.5.2. Download the appropriate version of VisIt for your machine and extract it to a folder called "visit" in your home directory. VisIt should be run at least once before using ICE to make sure it works on your system.
+=== Prerequisites ===
-### HDF5
+ICE requires a Java Development Kit (JDK) with Java 1.8 or greater. Sun's version of Java can be used on Linux, Windows, or Mac, and OpenJDK can also be used on Linux and Mac. The ICE development team prefers OpenJDK for Linux systems. Some tools in ICE also require the installation of third-party libraries. While it is not necessary to install these libraries to run ICE, the ''Reactors'' and ''Visualization'' perspectives will not work correctly without them.
-[HDF5](http://www.hdfgroup.org/HDF5/) is required if you intend to use the ICE ReactorAnalysis tools. If you will not be using the ReactorAnalysis tools, installing HDF5 is not required. You will need both HDFView and the binaries. As of the latest release, these are installed [together.](http://www.hdfgroup.org/products/java/release/download.html) Make sure that you install the proper versions of both for your architecture. The HDF5 Java and C libraries must be on your path.
+For Mac OS X users, ICE developers also recommend installing the [http://brew.sh/ Homebrew package manager].
-### 3D Graphics
+==== VisIt (Optional) ====
-ICE also requires that your system has 3D rendering enabled to edit geometries, which is normally done by installing the 3d graphics drivers from the vendor of your graphics card. You should consult your IT specialist if you do not know how to enable this on your own.
+To visualize 3D data, ICE requires the installation of VisIt (minimum version 2.8.2) on a local ''or'' remote machine.
-Please note that some of the above packages may be optional for running the binary version of ICE, but if you are one of the brave souls trying to build ICE from scratch all of the above packages are **required.**
+VisIt is available for download from the [https://wci.llnl.gov/simulation/computer-codes/visit/executables Lawrence Livermore National Laboratory website], and doesn't require any additional configuration to use with ICE.
-## Downloading ICE
+==== ParaView (Optional) ====
-[[File:ICEFilesPage_xxxxxxx.png]]
+As an alternative to VisIt, ICE is also capable of using ParaView instead, also on either a local ''or'' remote machine.
-Binary distributions of ICE are available [here](), which is also depicted in the thumbnail image to the right. The latest stable version of ICE is version 2.1.5. The binary distribution is a fully-functional, full-featured, executable version of ICE that includes everything except for the Java Virtual Machine, VisIt and plug-ins currently in development.
+ParaView is available for download from the [https://wci.llnl.gov/simulation/computer-codes/visit/executables official ParaView website], and also doesn't require any additional configuration to use with ICE.
-The "files" folder contains several subfolders and extra files. You should select the appropriate file named ICE2.x.y-*.zip where the * is the correct operating system and processor architecture for your system and x and y are major and minor version numbers. The choices are as follows:
+==== 3D Graphics ====
-  * ICE2.x.y-win32.win32.x86_64.zip - ICE for 64bit versions of Windows, including Windows 7.
+ICE also requires that your system has 3D rendering enabled to edit geometries and visualize 3D data, which is normally done by installing the 3D graphics drivers from the vendor of your graphics card. You should consult your IT specialist if you do not know how to enable this feature on your machine.
-  * ICE2.x.y-win32.win32.x86.zip - ICE for 32bit versions of Windows, including most installs of Windows XP.
-  * ICE2.x.y-macosx.cocoa.x86_64.zip - ICE for 64bit Mac, including OS/X.
-  * ICE2.x.y-macos.cocoa.x86.zip - ICE for 32bit Mac.
-  * ICE2.x.y-linux.gtk.x86_64.zip - ICE for 64bit Linux running GTK. (Most flavors of Linux.)
-  * ICE2.x.y-linux.gtk.x86.zip - ICE for 32bit Linux running GTK. (Most 32bit installs of Linux.)
-On a 64bit installation of Red Hat Enterprise Linux 6 (RHEL6), the ICE.product-linux.gtk.x86_64 version of ICE is the appropriate choice. For Windows 7, ICE.product-win32.win32.x86_64.zip should be selected.
+Certain features in ICE, currently including the Geometry and Mesh editors, also require JavaFX. This is included in most versions of the JDK, but default distributions for some Linux operating systems (including Fedora and CentOS) do not. In that case, you will need to download the official nightly build from [https://jdk8.java.net/download.html the Java website]. Then in the terminal, run
-## Running ICE
+'''alternatives --install /usr/bin/java java /path/to/the/jdk installation/jre/bin/java 3'''
-Once you download the appropriate zip file for your computer, unzip it to a directory of your choice. No additional installation steps are required because ICE is executed directly from this directory.
+or some number other than 3 if you already have multiple jdk installations. Then run
-**On a Mac** you might get a message that says that ICE is from an unidentified developer and cannot be opened. You can simple right-click the executable, click "Open" in the menu that appears and then click "OK" when prompted again.
+'''alternatives --config java'''
-**On Windows,** navigate to the folder where you installed ICE and in the ICE folder, double-click ICE.exe. On Linux and Mac systems, you may follow the same procedure, but the ICE executable is only called "ICE" on those systems. Alternatively for Linux and Mac systems you may execute ICE from the shell.
+And type in the number you assigned to the new JDK in the previous step.
-ICE will open a console that displays debug information and allows for expert debugging in addition to the user interface for your interactions. You may safely ignore this window while you are working.
+== Running ICE ==
-## What do I do if ICE fails to run?
+Once you download the appropriate zip file for your operating system, extract it to a directory of your choice. No additional installation steps are required because ICE is executed directly from this directory.
-If ICE fails to run, you should send an email to billingsjj &lt;at&gt; ornl &lt;dot&gt; gov. If you believe that you have identified a bug, please report it to [our bug tracker](https://bugs.eclipse.org/bugs/describecomponents.cgi?product=Ice).
+;Windows
+: In the file browser, navigate to the folder where you extracted ICE. In the ICE folder, double-click <tt>ICE.exe</tt>. On Linux and Mac systems, you may follow the same procedure, but the ICE executable is only called <tt>ICE</tt> on those systems.
-## Install Problems: Tips &amp; Tricks
+;Mac OS
+: You may get a message that says that ICE is from an unidentified developer and cannot be opened. Workaround: in the file browser right-click (or control-click) the <tt>ICE</tt> executable, click ''Open'' in the context menu, and then click ''OK'' when prompted again. Alternatively, ICE may be executed from the command line on Linux and Mac systems.
-The following tips are all about modifying the ICE.ini file to invoke special behavior. There is one very important thing to keep in mind about the INI files on Windows: make sure you put your new "-D" options on their own line!
+;Linux
+: ICE may be executed from the command line on Linux systems by navigating to the folder where ICE was extracted, and then issuing the command <code>./ICE</code>.
-### VisIt
+When ICE is executed, it will display data and debug information in the console window as the environment runs. You may safely ignore this window while you are working by keeping it minimized or in the background.
-The VisIt binary executable path should point to the directory that contains visit/visit.exe if it is not on the system path. This can be configured in the ICE.ini file using something like: -Dvisit.binpath=C:\Program Files\LLNL\VisIt 2.5.2
+== What if ICE fails to run? ==
-The ICE Development Team prefers to install VisIt in a system location and then use symbolic links to our home directories, as such:
+If you feel you've followed all the above directions for configuring ICE and its dependencies, and ICE still fails to run, email us directly at '''<tt>ice-dev <at> eclipse.org</tt>'''. If you believe that you have identified a bug, please report it to [https://github.com/eclipse/ice/issues our GitHub bug tracker].
-  * On Linux from /home/yourUsername, "ln -s visit-2.5.2/ visit"
-  * On Mac from /Users/yourUsername, "ln -s /Applications/VisIt.app/Contents/Resources/ visit"
-### HDF5
-On Linux machines it is not sufficient to add the HDF5 and HDFView libraries to your ld.so.config file. They must be added to your "LD_LIBRARY_PATH" variable. If you do not know how to do this, you can run the following script from your home directory and replace &lt;path_to_hdfview-libs&gt; and &lt;path-to-hdf5-libs&gt; to your library directories for those packages as appropriate. The first part of this script backs up your current configuration and the second part appends the necessary variables to your .bashrc file.
-    cp .bashrc .bashrc.backup
-    echo "LD_LIBRARY_PATH"=<path_to_hdfview-libs>:<path-to-hdf5-libs>:$LD_LIBRARY_PATH
-    export LD_LIBRARY_PATH
-If your HDF5 libraries are stored in /opt/hdf5 and your hdfview libraries are in your home directory this would look like
-    cp .bashrc .bashrc.backup
-    echo "LD_LIBRARY_PATH"=$HOME/hdfview/lib/linux:/opt/hdf5/lib:$LD_LIBRARY_PATH
-    export LD_LIBRARY_PATH
-If you make a mistake, you can restore your old .bashrc by replacing .bashrc with .bashrc.backup that was created by the script.
-In addition to this, you may need to add these files in your ld.so.conf file. Speak to your system administrator if you do not know how to do this.
-The location of the HDFView package can also be specified with the java.library.path option in the ICE.ini file, although this may prevent access to other system libraries. For example: -Djava.library.path=C:\Users\My Username\hdfview\lib\win -Djava.library.path=/home/myUsername/hdfview/lib/linux
-Some Windows configurations, particularly those where HDFView is installed in user land, may fail to load the hdf-java DLL files in hdfview\lib\win even if they can be found. In some cases ICE will throw a Java exception that says "UnsatisfiedLinkError: Access is denied." This can be fixed by granting the HDFView libraries 'Full Control' access rights for your user, as show below, by right-clicking on the DLL and selecting "Properties." This should be done for both jhdf5.dll and jhdf.dll.
-[[File:ICEWin7HDFControls.png]]

Breadcrumbs

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.