Difference between revisions of "ICE Developer Documentation"

Revision as of 15:54, 25 June 2015

This page is for programmers who would like to know the internal workings of ICE and/or intend to modify the code. For regular users, the ICE main page would probably be more helpful.

Fundamentals

ICE Build Instructions - Details on how to download, install and run ICE from the source code.

Forking Eclipse ICE - Describes the process of contributing to the ICE project from your own repository.

ICE Development Process and Guidelines - How we "make it do what it do".

Developer Tutorials

MyFirstPlug-in

Part 1: Extending ICE with custom Items

Part 2: Using the Job Profile Editor to create Job Launchers

Part 3: Creating a Java-based Job Launcher with an OSGi ICE plug-in

Part 4: Extending your plug-in to generate input files

Creating an ICE XML File From Schema - A Tutorial for creating XML files with the ICE file schema.

Creating OSGi Bundles from Third-Party JARs - Information on creating OSGi bundles based on pre-existing Java JARs.

Documentation

The following section includes information about ICE features that may still be in active development, so be warned: "Here there be dragons!"

Algorithms for Clustering data - This details the algorithms used to cluster the nuclear reactor simulation data.

Anomaly Detection Tool Test Cases - Details of the test cases use for clustering algorithm.

Basic Statistical Analysis of LWR Pin Power Data - Details concerning basic statistical analysis of LWR pin power dataset comparisons.

Clustering with Hadoop - Data analysis with large scale nuclear simulation data.

ICE Eclipse Icons - We use these icons for ICE.

Enabling Real-time Simulation Updates with ICEUpdater - Details on how to build and utilize the ICEUpdater library.

Javadoc - The JavaDoc reference manual for ICE.

Migrating ICE to Eclipse 4 - Details on the migration from Eclipse 3.7.2 to Eclipse 4.2.2.

References for KDD work - A list of the references for KDD work, including the work on Map-Reduce.

ICE Data Structures

Overview of ICE Data Structures - An overview of ICE's data structures and the philosophy behind them.

About ICE Data Structures - A description of each of the more commonly used ICE data structures, and their purpose.

CAEBAT in ICE - Description of the structure and usage of CAEBAT in ICE.

ICE Geometry Editor - A partial list of features and requirements for the ICE Geometry Editor.

ICE Job Profile - Information on creating Job Profiles in ICE.

Nek5000 Notes - Basic information on Nek5000, plugin development, and usage.

ICE LWR Object Model - A description of the LWR model in ICE.

ICE SFR Object Model - A description of the SFR model in ICE.

Painfully Simple Form - Documentation on ICE's "Painfully Simple Forms" and its associated file format.

Resources for TableViewer - Documentation and references on TableViewer.

Additional Tools in ICE

Better Exception Testing in ICE with J-Unit - Tutorial for developing better unit testing practices using J-Unit.

Challenges Using HDF5 and Java with ICE - Description of technical challenges and their solutions using HDF5 and Java.

JAXB in ICE - Details on using JAXB in ICE.

ICE and HDF5 - Provides a basic explanation of HDF5 and its role in ICE.

ICE-VR - Information on ICE's support for Virtual Reality environments.

Persistence in ICE - Article discussing various database connections and XML Parsing in ICE.

Replacing the jME3 Bundle in ICE - Instructions for replacing the JARs responsible for rendering 3D geometry in ICE.

Miscellaneous

Archives - A collection of links to articles that are either no longer relevant or in dire need of revision.