Attachment 80701 Details for Bug 206405 – New Project tutorial

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] New Project tutorial

206405.txt (text/plain), 9.89 KB, created by John Thomas

on 2007-10-18 16:40:00 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: John Thomas

Created: 2007-10-18 16:40:00 EDT

Size: 9.89 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.ohf.stem.doc
>Index: help/html/tutorials/projecttutorial.html
>===================================================================
>RCS file: /cvsroot/technology/org.eclipse.ohf/plugins/org.eclipse.ohf.stem.doc/help/html/tutorials/projecttutorial.html,v
>retrieving revision 1.1
>diff -u -r1.1 projecttutorial.html
>--- help/html/tutorials/projecttutorial.html	18 Jun 2007 17:49:46 -0000	1.1
>+++ help/html/tutorials/projecttutorial.html	18 Oct 2007 20:37:40 -0000
>@@ -6,6 +6,105 @@
> </head>
> <body>
> <h1>Creating a new Project Tutorial</h1>
>-Not written yet.
>+
>+<p>
>+The names used to create the Test project are in parentheses. 
>+Substitute your names as appropriate. 
>+In this example, the scenario will be for Japan.
>+<p>
>+Note: There are icons for many of the actions but for clarity 
>+the menubar items are used.. 
>+
>+<h3>Creating the Project</h3>
>+<ul>
>+<li>Click on New->STEM project and create new STEM project (Test)
>+<li>Click "Next" if you want to update the DublinCore data.
>+<li>Click "Finish"
>+<li> Open the new project  you should see several folders including: decorators, graphs, etc.
>+</ul>
>+
>+<h3>Creating a new Model</h3>
>+<ul>
>+<li> Click on New->Model to create new model (TestModel)
>+<li> Click "Next" to fill in any Dublin core data you want to add
>+<li> Select "Finish"
>+</ul>
>+
>+<h3>Add either a New or Built-in Disease</h3>
>+
>+<h4>Adding an existing built-in Disease to the Model</h4>
>+<ul>
>+<li>On the bottom Diseases tab, click on STEM->Built-in
>+<li>select "Spanish Flu"  
>+<li>DRAG your disease (e.g., Spanish Flu) into the model (TestModel)
>+ in the Rescource Set window. Expand the "TestModel" in the Resource Set window to see that it worked.
>+</ul>
>+
>+<h4>Adding a New Disease to the Model</h4>
>+<ul>
>+<li>On the menu bar click New>New Disease
>+<li>Fill in the Name: (TestDisease)
>+<li>Fill in the Disease Name: (TestDiseaseName). 
>+    Remember this name for the Infector creation.
>+<li>Select the DiseaseModel in the ComboBox: 
>+   e.g., select  "DeterministicSEIRDiseaseModelImpl"
>+<li>Fill in any Dublin core data you want to add ((ignore type)
>+<li>Click finish
>+<li>Under decorators you should see TestDisease.standard
>+<li>DoubleClick models->TestModel in the project explorer. You should see TestModel in the Resource Set.
>+<li>DRAG your new disease (e.g., TestDisease.Standard) from decorators (in the project explorer window)  into the model "TestModel" in the Rescource Set window. Expand the "TestModel" in the Resource Set window to see that it worked.
>+</ul>
>+
>+<h3>Adding the Geographical data to the Model</h3>
>+<ul>
>+<li>To add the geography data for Japan, at the bottom panel under Models, 
>+click on >STEM>Geography>Political>Country>JPN>JPN(0,1,2) full infrastructure
>+<li>Drag this up to the Model (TestModel) in the Resource set window
>+
>+<li>save your work at this point by hitting <b>ctrl-s</b>
>+</ul>
>+<h3>Create a Scenario and add your model to it</h3>
>+<ul>
>+<li>click on New->Scenario to create new scenario
>+<li>give it a name (TestScenario))
>+<li>Fill in any Dublin core data you want to add
>+<li>click finish
>+<li>From the Project Explorer window, 
>+under Models, Drag the new model (TestModel) into 
>+the new Scenario in the Resource Set. 
>+<li>Expand the scenario so you can see that it worked.
>+</ul>
>+
>+<h3>Add a sequencer to the Scenario</h3>
>+<ul>
>+<li>Go to Sequencers on the bottom window - expand fully
>+<li>drag Sequential Sequencer 2006 into the Scenario in the Resource Set
>+<li>An alternative would be to use New->SequentialSequencer 
>+to create the sequencer.
>+</ul>
>+
>+<h3>Creating and adding an Infector</h3>
>+<ul>
>+<li>Click on New->New Infector 
>+<li>Name it (TestInfector), 
>+<li>Enter Disease Name;  
>+    if you created a new Disease it will be the name that 
>+    you specified (TestDiseaseName)  or  
>+   "Spanish Flu" if you used the builtin disease.
>+<li>Fill in location for Infector:
>+  <ul>
>+   <li>Select "Japan" for country.
>+   <li>Select a level 1 admin area name. (e.g. "Kinki")
>+   <li>Select a Level 2 admin area name. (e.g. "Kyoto")
>+  </ul> 
>+<li>Click on the Scenario to open it in the Resource set
>+<li>drag the TestInfector from Decorators into the scenario 
>+
>+</ul>
>+
>+<h3>Save your work at this point by hitting <b>ctrl-s</b></h3>
>+
>+<h3>Select the scenario from the Project window  and select
>+<b>run</b> from the popup menu.</h3>
> </body>
> </html>
>\ No newline at end of file
>Index: help/html/interface/views/ge.html
>===================================================================
>RCS file: /cvsroot/technology/org.eclipse.ohf/plugins/org.eclipse.ohf.stem.doc/help/html/interface/views/ge.html,v
>retrieving revision 1.1
>diff -u -r1.1 ge.html
>--- help/html/interface/views/ge.html	18 Jun 2007 17:49:41 -0000	1.1
>+++ help/html/interface/views/ge.html	18 Oct 2007 20:37:39 -0000
>@@ -43,8 +43,9 @@
> 	<li>Select the GoogleEarth View from the Tabbed Window. <br>
> 	This should start the GoogleEarth application if it was not
> 	already started. The STEM-GoogleEarth interface has many options that
>-	can be set from <b>Windows->preferences->STEM->GoogleEarth</b> However,
>-	we can use the defaults for our first run. 
>+	can be set from 
>+	<b>Windows->preferences->STEM->Visualization->Geographic->GoogleEarth</b> 
>+	However, we can use the defaults for our first run. 
> 	<li>Start a new simulation by selecting the Scenario window. 
> 	<li>Select the USA scenario. STEM->Geography->Political->Country->USA
> 	<li>double clicking the "Spanish Flu" <a href="../../concepts/modelingframework.html#scenario"> Scenario</a>.
>@@ -89,5 +90,39 @@
>   If you are running the STEM standalone executable, the above steps were 
>   already done for you and you just need to start STEM.exe.
>   
>+  <h2>Context Menu</h2>
>+  If you bring up the context menu (Right click in Windows) then you will 
>+  get a menu where you can issue some control commands or options for the 
>+  STEM/GoogleEarth interface.  The difference between the context menu and 
>+  the <b>Prefereces</b> is that the context menu only affects the current 
>+  invocation.  
>+  <ul>
>+   <li><em>Display Admin Area</em><br>
>+     This will bring up a menu where you can specify an admin area and 
>+     have if displayed on the GoogleEarth map.  This has nothing to do 
>+     with STEM but it was useful during our develpment of the STEM 
>+     geography files and has been left in.
>+   <li><em>Display Status</em><br>
>+     This will display on the console the status of the STEM/GoogleEarth 
>+     internal interface.  It is a useful debug tool.
>+   <li><em>Debug On/Off</em><br>
>+     Turns on  or off the debug output.
>+   <li><em>GoogleEarth Start</em><br>
>+     Startup GoogleEarth application if it is not already started.
>+   <li><em>GoogleEarth Restart</em><br>
>+     If GoogleEarth was for any reason stopped or crashed, 
>+     this will attempt to get it running again with the current 
>+     STEM status. It may not work.
>+   <li><em>GoogleEarth Run</em><br>
>+     This is used if you have already captured the KML log files and 
>+     you want to run them after the simulation is complete.
>+     It will let you specify the folder containing the KML files and 
>+     will send them one by one to GoogleEarth.
>+   <li><em>GoogleEarth Stop</em><br>
>+     This will stop the sending of files to GoogleEarth and 
>+     clear the polygons already displayed. 
>+   
>+  </ul>
>+    
> </body>
> </html>
>Index: help/html/interface/preferences/preferencesgetoplevel.html
>===================================================================
>RCS file: /cvsroot/technology/org.eclipse.ohf/plugins/org.eclipse.ohf.stem.doc/help/html/interface/preferences/preferencesgetoplevel.html,v
>retrieving revision 1.1
>diff -u -r1.1 preferencesgetoplevel.html
>--- help/html/interface/preferences/preferencesgetoplevel.html	18 Jun 2007 17:49:43 -0000	1.1
>+++ help/html/interface/preferences/preferencesgetoplevel.html	18 Oct 2007 20:37:39 -0000
>@@ -26,7 +26,7 @@
> 	overlaying the file written for the previous cycle. GoogleEarth 
> 	asks for new data on a predetermined interval and is sent the 
> 	current KML.  The advantage over the previous method is that 
>-	it helps keep GoogleEarth from falling to far behind the STEM processing.</li>
>+	it helps keep GoogleEarth from falling too far behind the STEM processing.</li>
> 	<li><em>"DirectLaunch"</em><br>With this option, the KML files 
> 	are directly sent to GoogleEarth without using an intermediate 
> 	web server. This can cause problems because GoogleEarth may get 
>@@ -38,7 +38,7 @@
> 	STEM will write the KML files that GoogleEarth will read.  
> 	If it already contains KML files, the user will be given 
> 	the oportunity to delete them, keep them or choose a new folder.</li>
>-  <li><em>"User internal webserver"</em><br>This is used to cause the 
>+  <li><em>"Use internal webserver"</em><br>This is used to cause the 
>     webserver built into Eclipse to be used.</li>
>   <li><em>"Hostname:port for external webserver"</em>
>     <br>This is the required hostname and port for an external webserver. 
>@@ -50,12 +50,15 @@
>   <li><em>"Automatically process every simulation"</em>
>     <br>if specified, then when you start any simulation running, 
>     it will automatically have its processing be mapped to GoogleEarth.  
>-    Only the first one will be displayed by GE since it would 
>+    Only one simulation will be displayed by GE since it would 
>     be counterproductive to show 2 different views at the same time. </li>
>   <li><em>"Write KML files only every N th cycle"</em>
>     <br>If the simulation does not change rapidly from cycle to cycle, 
>     significant overhead can be saved by only sending data to 
>     GoogleEarth every Nth cycle.</li>
>+  <li><em>"Chose Aspect to be Logged.cycle"</em>
>+    <br>Select the disease aspect to be displayed as colored polygons
>+    on the GoogleEarth map.</li>
> </ul>
> <img src="img/preferencesgetoplevel.jpg" />
> </body>

Flags:

webdaford: iplog+

Actions: View | Diff

Attachments on bug 206405: 80701