Developer Documentation

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

Table of Contents

• Fundamentals
• Tutorials
• Documentation
  • NiCE's Data Structures
  • Additional Tools in NiCE
• Miscellaneous

Fundamentals

Compiling NiCE From Scratch - Detailed build instructions for NiCE.
Development Process and Guidelines - How we "make it do what it do".

Tutorials

Your First Plug-in Part 1: Extending NiCE with custom Items
Your First Plug-in Part 2: Using the Job Profile Editor to create Job Launchers
Your First Plug-in Part 3: Creating a Java-based Job Launcher with an OSGi NiCE plug-in
Your First Plug-in Part 4: Extending your plug-in to generate input files
Creating a NiCE XML File From Schema - A Tutorial for creating XML files with the a provided schema file for NiCE.

Creating OSGi Bundles from 3rd Party JARs - Information on creating OSGi bundles based on pre-existing Java .jar files.

Documentation

Here are links to some good articles on pieces of NiCE that are still in development. Many of the pieces discussed are also 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.
Eclipse Icons - We use these icons for NiCE.
Enabling Real-time Simulation Updates with NiCEUpdater - Details on how to build and utilize the NiCEUpdater library.
Javadoc - The JavaDoc reference manual for NiCE.
Migrating to Eclipse 4 - Details on the migration from Eclipse 3.7.2 to Eclipse 4.2.2.
References for KDD work - Detailed list of the references for KDD work, including the work on Map-Reduce.

NiCE's Data Structures

About NiCE Data Structures - A brief description of each of the more commonly used NiCE data structures and their purpose.
CAEBAT - Description of the structure and usage of CAEBAT.
Data Structures in NiCE - Documentation on NiCE's data structures.
Geometry Editor - A partial list of features and requirements for the NiCE Geometry Editor.
Job Profile - Information on creating Job Profiles in NiCE.
Nek5000 Notes - Basic information on Nek5000, plugin development, and usage.
NiCE LWR Object Model - A description of the LWR model in NiCE.
NiCE SFR Object Model - A description of the SFR model in NiCE.
Painfully Simple Form - Documentation on NiCE's "Painfully Simple Forms" and the associated file format.
Resources for TableViewer - Documentation and references on TableViewer.

Additional Tools in NiCE

Better Exception Testing with JUNIT - Tutorial for unit testing in JUNIT with expected exceptions.
Challenges Using HDF5 and Java - Description of technical challenges and their solutions using HDF5 and Java.
JAXB in NiCE - Details on using JAXB in NiCE.
NiCE and HDF5 - Provides a basic explanation of HDF5 in NiCE.
NiCE-VR - Information on NiCE's support for Virtual Reality environments.
Persistence in NiCE - Article discussing various database connections and XML Parsing in NiCE.
Replacing the jME3 Bundle in NiCE - Instructions for replacing the jars responsible for rendering 3d geometry in NiCE.
Using VisIt in NiCE - Details on using the VisIt Java API as an OSGi bundle and the VisItAnalysisTools plugin in NiCE.

Miscellaneous

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