Jump to: navigation, search

Difference between revisions of "STEM Loggers"

(Create a Logger)
Line 28: Line 28:
 
# Your new Logger should automatically open in an Editor window
 
# Your new Logger should automatically open in an Editor window
 
#: '' In the '''Project Explorer''', The Logger should also be listed under the Project's Loggers ''
 
#: '' In the '''Project Explorer''', The Logger should also be listed under the Project's Loggers ''
#: [[Image:STEMLoggers_Scenario.png]]
+
#: [[Image:STEMLoggers_Editor.png|500px]]
  
 
=== Add the Logger to a Scenario ===
 
=== Add the Logger to a Scenario ===
Line 37: Line 37:
 
# Select the Logger you wish to add and drag it to the '''Scenario''' in the '''Scenario Editor'''
 
# Select the Logger you wish to add and drag it to the '''Scenario''' in the '''Scenario Editor'''
 
#: '' '''Tip:''' Scenarios can have multiple loggers. Repeat this step for each Logger you want to add to the Scenario''
 
#: '' '''Tip:''' Scenarios can have multiple loggers. Repeat this step for each Logger you want to add to the Scenario''
# Save the '''Scenario'''
+
#: [[Image:STEMLoggers_Scenario.png|500px]]
 +
# When finished editing, save the '''Scenario'''
  
 
=== Simulation Logging ===
 
=== Simulation Logging ===

Revision as of 19:48, 19 January 2012

About STEM Loggers

<insert some boilerplate welcome text>

Simulation Logging in STEM

Create a Logger

Creating a STEM Logger is similar to creating STEM Models, Scenarios, Decorators, etc. A wizard is provided to guide you through the steps.

  1. Before you begin, launch STEM, switch to the Design perspective and make sure you have at least one STEM Project in the Project Explorer
  2. Launch the New Logger wizard by clicking the "Create a new logger" button
    STEMLoggers CreateButton.png
  3. This will load the New Logger wizard
    STEMLoggers NewLoggerWizard.png
  4. In the New Logger Wizard, select a Project from the dropdown menu and enter a Name
    Tip: The new logger's configuration will be stored in <PROJECT>/Loggers/<NAME>.logger.
  5. Select a Logger Type from the dropdown menu
    Options include:
    • CSV File Logger
    • Map View Logger
    • Several project map loggers, including:
      • Equirectangular Map Logger
      • Mercator Map Logger
      • Orthographic Map Logger
      • Azimuthal Equidistant Map Logger
  6. Configure the logger by entering logger type-specific settings
    Note: See the section below for help configuring each logger type
  7. When you're finished, click Next or Finished if you do not need to change the logger Dublin Core metadata
  8. Your new Logger should automatically open in an Editor window
    In the Project Explorer, The Logger should also be listed under the Project's Loggers
    STEMLoggers Editor.png

Add the Logger to a Scenario

Once the Logger is created, you're ready to move on and add it to a Scenario.

  1. In STEM, Create a new Scenario or Open an existing Scenario
  2. Navigate to the Logger you wish to add by expanding its parent Project and then Loggers sub-tree in the Project Explorer
  3. Select the Logger you wish to add and drag it to the Scenario in the Scenario Editor
    Tip: Scenarios can have multiple loggers. Repeat this step for each Logger you want to add to the Scenario
    STEMLoggers Scenario.png
  4. When finished editing, save the Scenario

Simulation Logging

The STEM Logger Manager will automatically attach loggers to a Simulation from a Scenario containing one or more Loggers. By default, Loggers are enabled automatically when a simulation starts (this is configurable in your Logger's properties).

To disable or enable a logger once a simulation start, follow these steps

  1. Open the Active Loggers view
    • Open the Window menu then click Other
    • In the Show View dialog, select Active Loggers and click OK
    STEMLoggers ActiveLoggers.png
  2. In the Active Loggers view, expand the running simulation
  3. Right click on the Logger you wish to control
    • If the Logger is enabled, select Disable Logger to disable
    • If the Logger is disabled, select Enable Logger to enable
    STEMLoggers ActiveLoggersDisableLogger.png

Adding a Logger to a Scenario

Active Loggers View

Logger Configurations

Delimited File / CSV Logger

Projected Image Logger

Map Writer Logger

Creating Your Own Logger

Temp Images

STEMLoggers ActiveLoggers.png STEMLoggers ActiveLoggersDisableLogger.png STEMLoggers CreateButton.png STEMLoggers Editor.png STEMLoggers NewLoggerWizard.png STEMLoggers Scenario.png STEMLoggers SelectCompartments.png