STEM Loggers are configurable on a per-logger basis and contain various settings for each logger type.

STEM Loggers are configurable on a per-logger basis and contain various settings for each logger type.

−

=== Selecting Logger Compartments ===

−

A new feature of STEM Loggers is to ability to select specific disease/population model properties / compartments to record. Limiting the compartments being logged helps prevent huge amounts of irrelevant data being logged, reducing storage costs and increasing performance in disease models that have large number of compartment (such as Dengue).

−

A compartment in STEM is made up of three components:

−

* The Diesease or Population Model

−

* The population identifier

−

* The disease property or compartment

−

−

You need to crease at least one disease or population decorator in your STEM workspace before creating a logger. Then, in the New Logger wizard, click the '''Select Compartments''' button.

−

−

<select compartments window>

−

−

[[Image:STEMLoggers_SelectCompartments.png|500px]]

−

−

# To select compartments for a logger, click the '''Select Compartments''' button

−

#: In the '''Compartments to Log''' dialog

−

## In the ''' Project ''' dropdown, Select the project that contains the Disease or Population Model (Decorator)

−

## In the '''Decorator''' dropdown, select a Disease or Population Model. This will populate the '''Available Properties''' menu

−

## In the '''Available Properties''', select the compartments you wish to log and click '''Add'''. This places them in the '''Select properties''' list.

−

##: ''Repeat these steps until you have selected all the compartments you wish to log''

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.

Before you begin, launch STEM, switch to the Design perspective and make sure you have at least one STEM Project in the Project Explorer

Launch the New Logger wizard by clicking the "Create a new logger" button

This will load the New Logger wizard

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.

Select a Logger Type from the dropdown menu

Options include:

CSV File Logger

Map View Logger

Several projected map loggers, including:

Equirectangular Map Logger

Mercator Map Logger

Orthographic Map Logger

Azimuthal Equidistant Map Logger

Configure the logger by entering logger type-specific settings

Note: See the section below for help configuring each logger type

To choose Compartments to Log, click the Select Compartments button

Note Some loggers do not log compartments. Skip this step if you don't see a Select Compartments button

In the Compartments to Log dialog

In the Project dropdown, Select the project that contains the Disease or Population Model (Decorator)

In the Decorator dropdown, select a Disease or Population Model. This will populate the Available Properties menu

In the Available Properties, select the compartments you wish to log and click Add. This places them in the Select properties list.

Repeat these steps until you have selected all the compartments you wish to log

When finished selecting compartments, click OK

When you're finished, click Next or Finished if you do not need to change the logger Dublin Core metadata

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

Add the Logger to a Scenario

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

In STEM, Create a new Scenario or Open an existing Scenario

Navigate to the Logger you wish to add by expanding its parent Project and then Loggers sub-tree in the Project Explorer

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

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

Open the Active Loggers view

Open the Window menu then click Other

In the Show View dialog, select Active Loggers and click OK

In the Active Loggers view, expand the running simulation

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

Adding a Logger to a Scenario

Active Loggers View

Logger Configurations

STEM Loggers are configurable on a per-logger basis and contain various settings for each logger type.

General Settings

Setting

Type

Description

Enabled

Boolean

Whether the logger is enabled when a simulation starts. Default is "Yes"

Use Default Log Directory

Boolean

Whether to use the Default Logger Directory (Project/RecordedSimulations folder). Default is "Yes".

Log Directory

String/Path

Required if Use Default Log Directory is no. Useful if you want to log to an external device.

Run Every n Steps

Integer

Triggers the logger only every n simulation cycles/steps. A value of 1 runs every step. 2 would run on steps 0, 2, 4, etc. Default is 1.

Compartments to Log

List

The list of decorator compartments to log. See here for more details.

Delimited File / CSV Logger

Setting

Type

Description

File Delimeter

String

The character(s) to use to separate entries in the log. Default is a single comma ',' for CSV.

Log Run Parameters

Boolean

Whether to write a file containing the parameters used to initialize the simulation. Default is "Yes".

Log Writer Buffer Size

Integer

The number of bytes to write before flushing the log file buffer. Increased this number for better performance. Default is 1024 bytes.

Projected Image Loggers

Setting

Type

Description

Image Width

Integer

The image width in pixels of the image created by the logger. Default is 1000 pixels.

Image Height

Integer

The image height in pixels of the image created by the logger. Default is 500 pixels.

Force Aspect Ratio

Boolean

Whether the image's proportions should match those of the objects being written. If yes, the width or height of the image may be changed proportionally to prevent skewing. Default is "Yes".

Fit Canvas to Polygons

Boolean

Whether the canvas's bounds should be fit to the objects drawn or the projection. If Yes, then the canvas boundary is the bounding box of the objects being drawn. If No, then the canvas boundary is bounding box of the projection (useful for "whole Earth" views, such as creating a Google Maps overlay). Default is "Yes".

Origin Latitude*

Number

Required only for origin-dependent map projections. The latitude of the principal Y axis of the projection. Default is 0.0.

Origin Longitude*

Number

Required only for origin-dependent map projections. The latitude of the principal X axis of the projection. Default is 0.0.