<!doctype html public '-//W3C//DTD HTML 4.01//EN'
  'http://www.w3.org/TR/html4/strict.dtd'>
<html>
<title>Isight - Examples</title>
  <head>
	<link rel="stylesheet" href="../../EStyle.css" type="text/css">
	<link rel="stylesheet" href="../../ETables.css" type="text/css">
  </head>
<a href="http://www.simulia.com/products/sim_opt.html"><img src="../../../examples/logo.gif"></a>
<body>
<h1>Applications</h1>

<h2>Compiling and Running these Examples</h2>

	<p>&nbsp;</p>
	<p>Scripts are included to compile and run the examples and can be found in the examples/development/applications directory.</p>
	<p>Open a command window, navigate to this directory, and follow the instructions for your platform below.</p>
	<p>NOTE: The environment variable JAVA_JDK should be defined.</p>
	<p>Optionally, if you are compiling or running these programs from outside the examples/development/applications directory (ie, if you are at a command prompt but not currently in the applications directory), FIPER_HOME should also be defined.  If you 
	move the Java example files themselves to a new location, you must modify the package name specified at the top of the file to match the new location (as required by Java convention).</p>
	<ul>
		<li>JAVA_JDK should point to a Java JDK (1.5.0 or later).</li>
		<li>FIPER_HOME should point to the root directory of your Isight installation.</li>
	</ul>
	<h3>Windows</h3>
	<p>&nbsp;</p>
	<p>To compile an example, run the command <b>compileExample.bat (example name)</b></p>
	<p>To run an example, run the command <b>runExample.bat (example name) (example args NO QUOTES)</b></p>
	<h3>UNIX</h3>
	<p>&nbsp;</p>
	<p>To compile an example, run the command <b>compileExample (example name)</b></p>
	<p>To run an example, run the command <b>runExample (example name) (example args)</b></p>
<h2>Descriptions</h2>

<table>
	<th colspan=2>Design Driver API Example</th>
	<tr>
		<td>Description:</td>
		<td>This example java code demonstrates how to configure an optimization
			and a DOE component programmitically within an existing template model.</td>
	</tr>
	<tr>
		<td>Support files needed:</td>
		<td><a href="DesignDriverAPIExample.java">DesignDriverAPIExample.java</a></td>
	</tr>
	<tr>
		<td>Instructions:</td>
		<td>This code simply serves as an example of how you can access and modify various aspects of the
			DOE and Optimization design driver components.  There is no specific reasoning behind the
			various actions taken in this example.  Read through the code to see examples of how to modify
			technique options and design parameter attributes.  It also shows how to construct Optimization
			and DOE "plans" and execute them on simulations that are not represented by Isight workflows.
			Note that there are model filenames used within the code that will need to be adjusted to use
			your own files.
		</td>
	</tr>
</table>
<p><br>
<table>
	<th colspan=2>Programmatic Model Execution Example</th>
	<tr>
		<td>Description:</td>
		<td>This example java code demonstrates how to execute a Isight model programmatically.</td>
	</tr>
	<tr>
		<td>Support files needed:</td>
		<td><a href="ModelExecution.java">ModelExecution.java</a></td>
	</tr>
	<tr>
		<td>Instructions:</td>
		<td>The main() must be invoked from a startup script that establishes the proper environment.
			See the "fipercmd" startup script for an example of how Isight client applications need to be started.
			<p><br>
			This sample will run a model either on the SIMULIA Execution Engine or on the local machine (Isight), depending
			on the connection profile (.CPR file) used.  If the connection profile, user-id, and password are
			not supplied the user is prompted with the usual logon dialog before the model is run.
			<p><br>
			When the model completes, the result values of the root component's parameters are written to the
			console in a simple comma-delimited format. This program exits when the model completes execution.
			<p><br>
			This sample is designed to show the basic APIs and steps necessary to run a model and get results
			from the job.  To keep the code as simple as possible, extensive error checking and other robust
			features have been omitted.
			<p><br>
			Although this supports execution of models on the SIMULIA Execution Engine or locally, for the sake of simplicity it does
			not support the running of a model stored in the (shared or local) Library.  Only a ZMF model file from
			the local machine can be executed with this sample.  See the comments in the code for how to run a model
			stored in the library.
			<p><br>
			There are many other API features that are not used by this example.  See the Development Guide and the
			javadocs for the API classes for details.
			<p><br>
			Example usage:
			<p><br>
			<code>execmodel c:\mymodel.zmf</code>
		</td>
	</tr>
</table>
<p><br>
<table>
	<th colspan=2>Modelling API Example</th>
	<tr>
		<td>Description:</td>
		<td>This example java code demonstrates how to develop and configure a model programmatically.</td>
	</tr>
	<tr>
		<td>Support files needed:</td>
		<td><a href="ModellingAPIExample.java">ModellingAPIExample.java</a></td>
	</tr>
	<tr>
		<td>Instructions:</td>
		<td>This example has two primary methods that show (a) how to load an existing model from a file and
			launch it in the Runtime Gateway, and (b) how to build a model from scratch and save it.  Modify
			the main() method to call either or both of these methods.  Replace all .zmf model file names
			with appropriate existing model files on your computer.
		</td>
	</tr>
</table>
<p><br>
<table>
	<th colspan=2>Approximation API Example</th>
	<tr>
		<td>Description:</td>
		<td>This example java code demonstrates how to create, configure, initialize and use an approximation programmatically.</td>
	</tr>
	<tr>
		<td>Support files needed:</td>
		<td><a href="ApproxExample.java">ApproxExample.java</a><br> <a href="OLH-20-DataPoints.txt">OLH-20-DataPoints.txt</a></td>
	</tr>
	<tr>
		<td>Instructions:</td>
		<td>This example first creates an approximation component and configures an RBF model to use the data file 
			for initialization. After initialization, the approximation is evaluated at (0,0).
		</td>
	</tr>
</table>

<p><br>
<table>
	<th colspan=2>Customized WebTop Example for TomEE</th>
	<tr>
		<td>Description:</td>
		<td>This example demonstrates how to write a custom webtop for TomEE based SIMULIA Execution Engine (SEE).</td>
	</tr>
	
	<tr>
		<td>Instructions:</td>
		<td>Detailed instructions to compile and run example are documented in examples\development\applications\ExampleCustomWebTop\Example_Custom_WebTop_Instructions.docx file.
		</td>
	</tr>
</table>

<p><br>
<table>
	<th colspan=2>Customized WebTop Example for Websphere</th>
	<tr>
		<td>Description:</td>
		<td>This example demonstrates how to write a custom webtop for Websphere based SIMULIA Execution Engine (SEE).</td>
	</tr>
	<tr>
		<td>Instructions:</td>
		<td>Detailed instructions to compile and run example are documented in examples\development\applications\ExampleCustomWebTop\Example_Custom_WebTop_Instructions.docx file.
		</td>
	</tr>
</table>

</body>
</html>
