Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Getting ICE"

 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
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.  
 
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 Java 1.8 to build and run.'''
+
{{note|ICE requires the Java Development Kit version 8 to build and run.}}
  
== The Quick Way: Our Installers ==
+
== Installing ICE from Binaries ==
  
We recommend that you use our installers. They are the fastest way to properly install ICE and its dependencies. They install everything except for 3D graphics drivers and Java 1.8, which must be installed separately.
+
=== Downloading ICE ===
  
We have installers for Windows, [http://sourceforge.net/projects/niceproject/files/ICE_installer.sh Mac] and [http://sourceforge.net/projects/niceproject/files/ICE_installer.sh Linux] that you can download and execute without administrator privileges to install ICE on your machine. They are not distributed by the Eclipse Foundation and are available instead at the old project page on Sourceforge.net, which is maintained by the Jay Jay Billings, the ICE project lead.
+
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 Long Way: Manually ==
+
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.
  
=== Prerequisites ===
+
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.
  
ICE requires a Java Development Kit (JDK) with Java 1.7 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. Some tools in ICE also require the installation of third-party libraries. While it's not necessary to install these libraries to run ICE, the ''Reactors'' and ''Visualization'' perspectives will not work correctly without them.
+
{| 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
 +
|}
  
==== HDF-Java/HDFView (Optional) ====
+
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]].
  
To use the ''Reactor Analyzer'' tools, ICE requires HDF-Java libraries installed locally. These libraries are bundled into a product called HDFView, which is available for download from the  [https://www.hdfgroup.org/products/java/release/download.html HDF Group website]. We recommend you install HDFView in the default installation directory. On Windows you will need to run the HDFView installer and on Linux you will need to run the HDFView .sh script.
+
=== Prerequisites ===
  
Assuming the default installation location is used, '''Windows''' systems do not require any further configuration once HDFView is installed. However, Mac and Linux require a little extra jiggery-pokery.
+
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.
  
To configure HDFView on '''Mac''' systems so that ICE may use its libraries, add the following line to your <tt>~/.bash_profile</tt>:
+
For Mac OS X users, ICE developers also recommend installing the [http://brew.sh/ Homebrew package manager].
<pre>export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:<path_to_hdfjava_libs></pre>
+
For Macs, <tt><path_to_hdfjava_libs></tt> is <code>/Applications/HDFView.app/Contents/Resources/lib</code> by default.
+
 
+
To configure HDFView on '''Linux''' systems so that ICE may use its libraries, add the following line to your <tt>~/.bashrc</tt>:
+
<pre>export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<path_to_hdfjava_libs></pre>
+
 
+
Some flavors of Linux do not have ~/.bashrc or ~/.bash_profile files by default. You can copy them from /etc/skel/ if they are not available in your home directory.
+
 
+
For Linux systems, there is no default installation location, but rather, you will be asked where you would like to install HDFView. Thus, <tt><path_to_hdfjava_libs></tt> will correspond to <code>{install location}/HDF_Group/HDFView/2.10.1/lib</code>.
+
 
+
If you are unsure how to add these paths to your system properties, below are scripts you can run to accomplish the same tasks. If you make a mistake, you can restore your old <tt>~/.bash_profile</tt> or <tt>~/.bashrc</tt> by replacing it with the back-up file that was created by the script. In addition to this, you may need to add these files in your <tt>ld.so.conf</tt> file. Speak to your system administrator if you do not know how to do this.
+
 
+
===== Mac =====
+
<pre>cp .bash_profile .bash_profile.backup
+
echo "DYLD_LIBRARY_PATH"=<path_to_hdfjava_libs>:$DYLD_LIBRARY_PATH
+
export DYLD_LIBRARY_PATH</pre>
+
For example, if your HDF-Java libraries are stored in <code>/Applications/HDFView.app/Contents/Resources/lib</code>, the script would be as follows:
+
<pre>cp .bash_profile .bash_profile.backup
+
echo "DYLD_LIBRARY_PATH"=/Applications/HDFView.app/Contents/Resources/lib:$DYLD_LIBRARY_PATH
+
export DYLD_LIBRARY_PATH</pre>
+
 
+
===== Linux =====
+
<pre>cp .bashrc .bashrc.backup
+
echo "LD_LIBRARY_PATH"=<path_to_hdfjava_libs>:$LD_LIBRARY_PATH
+
export LD_LIBRARY_PATH
+
</pre>
+
For example, if your HDF-Java libraries are stored in <code>/home/some_user/HDFView-2.10/HDF_Group/HDFView/2.10.1/lib</code>, the script would be as follows:
+
<pre>
+
cp .bashrc .bashrc.backup
+
echo "LD_LIBRARY_PATH"=/home/some_user/HDFView-2.10/HDF_Group/HDFView/2.10.1/lib:$LD_LIBRARY_PATH
+
export LD_LIBRARY_PATH
+
</pre>
+
 
+
===== Using Custom Locations =====
+
 
+
If you'd like to install HDF-Java libraries in a location other than the default, you will need to take a few extra steps to ensure ICE knows where to find them.
+
 
+
For Windows and Linux users, begin by finding the <tt>ICE.ini</tt> file in the directory where you extracted the zipped ICE binary.
+
 
+
Open this file with a text editor and find the line that begins with "<code>-Djava.library.path</code>". For example, on a Windows machine, this would look something like:
+
<pre>
+
-Djava.library.path=C:\PROGRA~1\HDF_Group\HDFView\2.10.1\lib
+
</pre>
+
Change the filepath to match the location of your custom HDFView installation. For example, if I installed HDFView in the location <tt>C:\Users\Someone\HDFGroup\HDFView\2.10.1\lib</tt> on my system, then I would change the line in my <tt>ICE.ini</tt> file to:
+
<pre>
+
-Djava.library.path=C:\Users\Someone\HDFGroup\HDFView\2.10.1\lib
+
</pre>
+
You might notice filepaths in the <tt>ICE.ini</tt> file look a little funky. As long as you follow the above instructions, you don't need to worry about this. If you are still curious as to why this is, see our explanation in our [[ICE FAQ#What are the weird filepaths in the ICE.ini file? (Windows only)|ICE FAQ]].
+
  
 
==== VisIt (Optional) ====
 
==== VisIt (Optional) ====
Line 77: Line 48:
 
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.
 
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.
  
==== 3D Graphics ====
+
==== ParaView (Optional) ====
  
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 on your own.
+
As an alternative to VisIt, ICE is also capable of using ParaView instead, also on either a local ''or'' remote machine.  
  
=== Downloading ICE ===
+
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.
  
{| style="color: black; background-color: #ffffcc;" width="100%"
+
==== 3D Graphics ====
| Our binary build is temporarily unavailable here. If you'd like to obtain the binary version of ICE, please contact us at '''<tt>ice-dev <at> eclipse.org</tt>'''
+
|}
+
  
 +
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.
  
The latest stable version of ICE is version 2.1.6. The binary distribution is a fully-functional, full-featured, executable version of ICE that includes everything except for the Java Virtual Machine, third-party libraries and plug-ins currently in development.
+
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
  
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. For example, ''ICE2.1.6-win32.win32.x86_64.zip'' is ICE version 2.1.6 for 64-bit Windows. The choices are as follows:
+
'''alternatives --install /usr/bin/java java /path/to/the/jdk installation/jre/bin/java 3'''
  
{| class="wikitable" style="text-align:left;"
+
or some number other than 3 if you already have multiple jdk installations. Then run
|-
+
 
! width="250px" |'''Binary version'''
+
'''alternatives --config java'''
! | '''Operating System'''
+
|-
+
| ICE2.x.y-win32.win32.x86_64.zip
+
|  64-bit versions of Windows, including most installations of Windows Vista, 7 and 8
+
|-
+
| ICE2.x.y-win32.win32.x86.zip
+
| 32-bit versions of Windows, including most installations of Windows XP
+
|-
+
| ICE2.x.y-macosx.cocoa.x86_64.zip
+
| 64-bit Mac, including most OS X installations (10.4.7 "Tiger" and newer)
+
|-
+
| ICE2.x.y-macos.cocoa.x86.zip
+
| 32-bit Mac, including some OS X installations (10.4.4 "Tiger" to 10.6.8 "Snow Leopard")
+
|-
+
| ICE2.x.y-linux.gtk.x86_64.zip
+
| 64-bit Linux running GTK (most flavors of Linux)
+
|-
+
| ICE2.x.y-linux.gtk.x86.zip
+
| 32-bit Linux running GTK
+
|}
+
  
On a 64-bit installation of Red Hat Enterprise Linux 6 (RHEL6), the ''ICE.product-linux.gtk.x86_64.zip'' version of ICE is the appropriate choice.
+
And type in the number you assigned to the new JDK in the previous step.  
  
 
== Running ICE ==
 
== Running ICE ==
Line 125: Line 75:
 
: 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.
 
: 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.
  
;Macs
+
;Mac OS
: You may get a message that says that ICE is from an unidentified developer and cannot be opened. In the file browser, you can right-click the executable, click "Open" in the context menu that appears and then click "OK" when prompted again. Alternatively, ICE may be executed from the command line on Linux and Mac systems.
+
: 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.
  
 
;Linux
 
;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>.
 
: 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>.
  
When ICE runs, it will stream data to a console window that displays debug information as the environment is used. You may safely ignore this window while you are working by keeping it minimized or in the background.  
+
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? ==
 
== 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 <code>ice-dev <at> eclipse.org</code>. If you believe that you have identified a bug, please report it to [https://bugs.eclipse.org/bugs/describecomponents.cgi?product=Ice our bug tracker].
+
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].

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.

Note.png
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.

Back to the top