User Guide - Revision history

Fei: /* File Menu */

2006-11-03T23:03:11Z

File Menu

← Older revision		Revision as of 23:03, 3 November 2006
Line 28:		Line 28:
	*:SELES Scenario Files (generally with a .scn suffix) are used to group a set of GIS and model files. When opened, each sub-model file listed in the scenario file will be loaded in the order specified. This is useful, for example, to load a set of GIS raster layers that form the initial conditions for a simulation and a SELES Simulation Model.		*:SELES Scenario Files (generally with a .scn suffix) are used to group a set of GIS and model files. When opened, each sub-model file listed in the scenario file will be loaded in the order specified. This is useful, for example, to load a set of GIS raster layers that form the initial conditions for a simulation and a SELES Simulation Model.

	*c) '''DryRun''': Opens and “dry runs” a scenario file. A dry run performs all tasks in a scenario except for actually running a simulation.		*d) '''DryRun''': Opens and “dry runs” a scenario file. A dry run performs all tasks in a scenario except for actually running a simulation.

	*d) '''Close''': Close the current selected view. This can also be accomplished by clicking with the mouse on the “Close” icon (the “X”) on the top right corner of the view window.		*e) '''Close''': Close the current selected view. This can also be accomplished by clicking with the mouse on the “Close” icon (the “X”) on the top right corner of the view window.

	*e) '''CloseAll''': Close all views and documents.		*f) '''CloseAll''': Close all views and documents.

	*f) '''Save''': This option is the same as Save As.		*g) '''Save''': This option is the same as Save As.

	*g) '''Save As ...''': Save the raster in the currently active view as a GIS raster file or the		*h) '''Save As ...''': Save the raster in the currently active view as a GIS raster file or the
	currently displayed image in the view as a JPEG file. This option will bring up a file browser from which the directory and file name can be set. The “Save as type” pull-down menu allows selection of the type of information or GIS format to save. The directory for a GRASS GIS raster should be the “cell” directory of a GRASS mapset. The header and other required associated files will be automatically created in the correct directory of the mapset.		currently displayed image in the view as a JPEG file. This option will bring up a file browser from which the directory and file name can be set. The “Save as type” pull-down menu allows selection of the type of information or GIS format to save. The directory for a GRASS GIS raster should be the “cell” directory of a GRASS mapset. The header and other required associated files will be automatically created in the correct directory of the mapset.

	*h) '''List of recent documents''': Between the print options and the Exit option is a list of the recently opened documents (if any). A document can be re-opened or the window associated with a currently opened document can be activated by selecting from this list.		*i) '''List of recent documents''': Between the print options and the Exit option is a list of the recently opened documents (if any). A document can be re-opened or the window associated with a currently opened document can be activated by selecting from this list.

	*i) '''Exit''': Exit the SELES application. This can also be achieved by clicking with the mouse on the “Close” icon (the “X”) on the top right corner of the main application window.		*j) '''Exit''': Exit the SELES application. This can also be achieved by clicking with the mouse on the “Close” icon (the “X”) on the top right corner of the main application window.

	==View Menu==		==View Menu==

Fei: /* Dynamic Models Menu */

2006-11-03T22:05:55Z

Dynamic Models Menu

← Older revision		Revision as of 22:05, 3 November 2006
Line 207:		Line 207:
	**viii) '''Cancel''': If a simulation is currently running, Cancel is the same as Stop. If a simulation is not running, then Cancel will close the Simulation Control Dialog.		**viii) '''Cancel''': If a simulation is currently running, Cancel is the same as Stop. If a simulation is not running, then Cancel will close the Simulation Control Dialog.
	**ix) '''External Global Variables''': This is a list of global variables defined in landscape events. The initial state value of global variables is zero by default, but may be specified in a SELES Model file or dialogue. During a simulation, the values of dynamic variables are periodically updated in the dialog box. The current value of a global variable can be changed by selecting it in the scrollable list, typing a new value in the “Value” edit box and pressing “Set”. The initial state value of a variable can be similarly changed, pressing “Set Initial State” instead of “Set”.		**ix) '''External Global Variables''': This is a list of global variables defined in landscape events. The initial state value of global variables is zero by default, but may be specified in a SELES Model file or dialogue. During a simulation, the values of dynamic variables are periodically updated in the dialog box. The current value of a global variable can be changed by selecting it in the scrollable list, typing a new value in the “Value” edit box and pressing “Set”. The initial state value of a variable can be similarly changed, pressing “Set Initial State” instead of “Set”.

			*f) '''Simulation Probe''': This option brings up a dialog box that allows probing of internal values in landscape events/agents during simulation. The desired event can be selected from a drop-down menu as well as the desired property context. Values for the agent/cell, cluster/group, event/population and cell variables are shown in different areas of the dialog. If changes occur too fast to see, there is an option to slow down the simulation. Care must be taken when using the probe, since it must modify events to operate. As a consequence, making too many changes on the dialog runs the risk of crashing a simulation due to timing of the user interface operation and the separate simulation engine processes.

			*g) '''Model Report''': This option saves a dynamic model report to two files called “SelesModelReport.txt” and “SelesModelReport2.txt” in the current directory. These files organizes all the layer and global variables, and global constants in the model state-space by type and lists the events that include them in their definitions section. The files also indicate if a variable or constant appears on the left-hand side (LHS), right-hand side (RHS), both or neither of an expression in the named event. The only difference between the files is format – the first is easier for browse while the second is more suitable for loading into a spreadsheet. This is useful for model verification, since at a glance it is easy to see variables that are not used, misspelled or not declared properly. Particular attention should be paid to variables that have no initial state.

			*h) '''Simulation Priority''': This option allows users to set the priority level for the simulation engine. On a single-processor machine (i.e. most desktops and laptops), decreasing the engine priority to Low or Lowest can increase responsiveness of the user interface and other programs.

Fei: /* Dynamic Models Menu */

2006-11-03T22:04:29Z

Dynamic Models Menu

← Older revision		Revision as of 22:04, 3 November 2006
Line 194:		Line 194:
	**v) '''Variables and Output Viewnames''': There is a (partial) mapping from dynamic layer variables in landscape events to viewnames that contain the current (dynamic) spatial state of the variable. This mapping connects variables with the view in which the dynamic output layer for this variable is displayed during a simulation. If the viewname is “<unassigned>”, then the output state is not displayed (but will be maintained internally).		**v) '''Variables and Output Viewnames''': There is a (partial) mapping from dynamic layer variables in landscape events to viewnames that contain the current (dynamic) spatial state of the variable. This mapping connects variables with the view in which the dynamic output layer for this variable is displayed during a simulation. If the viewname is “<unassigned>”, then the output state is not displayed (but will be maintained internally).
	**vi) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .sel suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These SELES model files can be opened directly using the Open menu item in the Files menu described in section II.		**vi) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .sel suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These SELES model files can be opened directly using the Open menu item in the Files menu described in section II.

			*e) '''Simulate''': This displays a dialog that provides the necessary functions to control simulations. Once all the dynamic models are set up, then the simulation scenario is ready to run. Since this dialog is modeless, other actions can be performed while the box is on the screen, and while a simulation is in progress.
			*:[[Image:Simulation control.gif]]
			*:The dialog allows control of a simulation as follows:
			**i) '''Simulation Length''': Specifies (in days and years) the length of time to run a simulation. “Current Time” is an output value that shows the current time of a running simulation. Note that a SELES model may use any unit timestep. For convenience, the unit timestep is called a "day" on the user interface, where one year = 365.25 days. If the unit timestep in your model is not a day, then read "Days" as "Unit Timesteps" on SELES dialogues.
			**ii) '''Runs''': Total: Specifies the number of Monte Carlo simulation runs. This can only be set before a simulation starts. “Runs: Current” is an output value that shows the current Monte Carlo run number.
			**iii) '''Output Frequency''': Specifies how often the model in the currently selected view is to be redisplayed. (See notes on unit timestep above.)
			**iv) '''Step Size''': Specifies how the number of time-steps to be made when “stepping through” a simulation.
			**v) '''Simulate''': Starts a simulation (or a complete series of Monte Carlo simulations). This button will change to a “Stop” during the simulation. Pressing “Stop” will terminate the simulation.
			**vi) '''Pause''': Allows a simulation to pause. While on pause, this button will change to a “Continue” button. Pressing “Continue” will resume the simulation.
			**vii) '''Step''': Allows a simulation to be "stepped through" in discrete time steps. If the simulation has not yet begun, then pressing this button will start it. Once the time period specified by “Step Size” has passed, the simulation will pause. At this point the “Pause” button will change to “Continue”. The user can press “Step” again to continue the simulation for “Step Size” time units, or press “Continue” to continue the simulation without stepping. Note that the Step button can be pressed at any time during a simulation to enter step mode.
			**viii) '''Cancel''': If a simulation is currently running, Cancel is the same as Stop. If a simulation is not running, then Cancel will close the Simulation Control Dialog.
			**ix) '''External Global Variables''': This is a list of global variables defined in landscape events. The initial state value of global variables is zero by default, but may be specified in a SELES Model file or dialogue. During a simulation, the values of dynamic variables are periodically updated in the dialog box. The current value of a global variable can be changed by selecting it in the scrollable list, typing a new value in the “Value” edit box and pressing “Set”. The initial state value of a variable can be similarly changed, pressing “Set Initial State” instead of “Set”.

Fei: /* Dynamic Models Menu */

2006-11-03T22:00:31Z

Dynamic Models Menu

@@ Line 182: / Line 182: @@
 **ii) '''Output Frequency''': The value specifies how often the model is to be recomputed during a simulation. If the output frequency is zero, then the model will be recomputed every time an event occurs during the simulation. If the output frequency is negative, then the model will be recomputed every time one of the parameter layers is modified.
-*d) '''Model Output''': Model Output allows intermediate states of dynamic layers to be saved during a simulation.  The "Output Frequency" species how often the currently selected layer is to be saved. Each time the raster layer is saved, a new file is created with a unique filename: "BaseName#r.#s", where "BaseName" is the base filename, "#r" is the Monte Carlo run number, and "#s" is the sequence number for layer in this run. The “Filename Base or Directory” specifies where the raster layers are to be saved. If this names an existing directory, then the name of the currently selected layer will be used as the base filename, otherwise it specifies the full path and filename to be used as the base filename. For example, during run 2 with a filename base of “./results/test”, the sequence of files will be: './results/test2.1', './results/test2.2', etc.  The available output types are uncompressed and compressed GRASS binary and GRASS ASCII, ERDAS 8 and 16 bit and ARC ASCII. Model output is set up by pressing the OK button, and terminated by pressing the Stop Output button.
+*c) '''Model Output''': Model Output allows intermediate states of dynamic layers to be saved during a simulation.  The "Output Frequency" species how often the currently selected layer is to be saved. Each time the raster layer is saved, a new file is created with a unique filename: "BaseName#r.#s", where "BaseName" is the base filename, "#r" is the Monte Carlo run number, and "#s" is the sequence number for layer in this run. The “Filename Base or Directory” specifies where the raster layers are to be saved. If this names an existing directory, then the name of the currently selected layer will be used as the base filename, otherwise it specifies the full path and filename to be used as the base filename. For example, during run 2 with a filename base of “./results/test”, the sequence of files will be: './results/test2.1', './results/test2.2', etc.  The available output types are uncompressed and compressed GRASS binary and GRASS ASCII, ERDAS 8 and 16 bit and ARC ASCII. Model output is set up by pressing the OK button, and terminated by pressing the Stop Output button.
 *:[[Image:Output control.gif]]

Fei: /* Static Models Menu */

2006-11-03T21:54:31Z

Static Models Menu

← Older revision		Revision as of 21:54, 3 November 2006
Line 170:		Line 170:

	*f) '''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.		*f) '''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.

			==Dynamic Models Menu==
			There are three types of dynamic models available from this menu, a dialog box for setting up dynamic output of layers, and a dialog box for controlling simulations. Dynamic models generally produce a series of model instances or, in the case of Dynamic Value Models, a series of values, during the course of a simulation. All three dynamic models (Dynamic Site Model, Dynamic Value Model, Seles Model) may depend on other layers in the current scenario.

			*a) '''Dynamic Site Model''': A Dynamic Site Model is a site model that is re-computed periodically during a simulation. Since these models may depend on dynamically changing layers in the scenario, periodic recomputation of the model may produce different results.
			*:The dialog is identical to the static Site Model dialog except for an “Output Frequency” option. The value specified (in days and years) determines how often the site model is to be recomputed. For example, a value of 2 years will cause the model to be recomputed every 730.5 days or unit time steps. If the output frequency is zero, then the site model will be recomputed every time an event occurs during the simulation. If the output frequency is negative, then the model will be recomputed every time one of the parameter layers is modified. This may be useful if one or more of the parameter layers are being changed by an external model.

			*b) '''Dynamic Value Model''': A Dynamic Value Model is a value model that is re-computed periodically during a simulation. Since these models may depend on one or more dynamically changing layers in the scenario, periodic updating may produce different results. The dialog is similar to the static Value Model dialog with two additional options.
			*:[[Image:DSSVMG.gif]]
			**i) '''Output Filename''': If the “Save Output to File” option is chosen, then the output will be stored in the named file. Each run (of a Monte Carlo simulation) will be stored on a different line, and each output value will be separated by a tab character. This allows the model output to be loaded into a spreadsheet (e.g. Excel) for post-mortem analysis.
			**ii) '''Output Frequency''': The value specifies how often the model is to be recomputed during a simulation. If the output frequency is zero, then the model will be recomputed every time an event occurs during the simulation. If the output frequency is negative, then the model will be recomputed every time one of the parameter layers is modified.

			*d) '''Model Output''': Model Output allows intermediate states of dynamic layers to be saved during a simulation. The "Output Frequency" species how often the currently selected layer is to be saved. Each time the raster layer is saved, a new file is created with a unique filename: "BaseName#r.#s", where "BaseName" is the base filename, "#r" is the Monte Carlo run number, and "#s" is the sequence number for layer in this run. The “Filename Base or Directory” specifies where the raster layers are to be saved. If this names an existing directory, then the name of the currently selected layer will be used as the base filename, otherwise it specifies the full path and filename to be used as the base filename. For example, during run 2 with a filename base of “./results/test”, the sequence of files will be: './results/test2.1', './results/test2.2', etc. The available output types are uncompressed and compressed GRASS binary and GRASS ASCII, ERDAS 8 and 16 bit and ARC ASCII. Model output is set up by pressing the OK button, and terminated by pressing the Stop Output button.
			*:[[Image:Output control.gif]]

Fei: /* Static Models Menu */

2006-11-03T21:48:53Z

Static Models Menu

← Older revision		Revision as of 21:48, 3 November 2006
Line 169:		Line 169:
	*:Once the layer to align with has been selected, the top-left and bottom-right bounds of the original image are shown relative to the georeferencing of the “Align with Layer”. These are called the aligned bounds. Any portion of the layer outside the range of the "Align with Layer" is clipped. Once an appropriate "Align with Layer" has been selected, the operation is performed by pressing the OK button.		*:Once the layer to align with has been selected, the top-left and bottom-right bounds of the original image are shown relative to the georeferencing of the “Align with Layer”. These are called the aligned bounds. Any portion of the layer outside the range of the "Align with Layer" is clipped. Once an appropriate "Align with Layer" has been selected, the operation is performed by pressing the OK button.

	* f)'''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.		*f) '''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.

Fei: /* Static Models Menu */

2006-11-03T21:48:38Z

Static Models Menu

← Older revision		Revision as of 21:48, 3 November 2006
Line 169:		Line 169:
	*:Once the layer to align with has been selected, the top-left and bottom-right bounds of the original image are shown relative to the georeferencing of the “Align with Layer”. These are called the aligned bounds. Any portion of the layer outside the range of the "Align with Layer" is clipped. Once an appropriate "Align with Layer" has been selected, the operation is performed by pressing the OK button.		*:Once the layer to align with has been selected, the top-left and bottom-right bounds of the original image are shown relative to the georeferencing of the “Align with Layer”. These are called the aligned bounds. Any portion of the layer outside the range of the "Align with Layer" is clipped. Once an appropriate "Align with Layer" has been selected, the operation is performed by pressing the OK button.

	*f)'''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.		* f)'''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.

Fei: /* Static Models Menu */

2006-11-03T21:48:04Z

Static Models Menu

← Older revision		Revision as of 21:48, 3 November 2006
Line 164:		Line 164:
	**iv) '''Variable and Viewname drop-down lists''': the names of the views (windows) for layer variables used by the cell expression. For example, if the cell expression requires a layer variable called “topography”, then this variable will appear in the Variables list. This will map to view that contains topography in the Viewnames list. When opened, all current views are automatically linked to variables of the same name.		**iv) '''Variable and Viewname drop-down lists''': the names of the views (windows) for layer variables used by the cell expression. For example, if the cell expression requires a layer variable called “topography”, then this variable will appear in the Variables list. This will map to view that contains topography in the Viewnames list. When opened, all current views are automatically linked to variables of the same name.
	**v) '''Cell Expression Edit box''': This box allows users to type in an arbitrary cell expression, and can be used much like a console for querying or modifying the landscape state.		**v) '''Cell Expression Edit box''': This box allows users to type in an arbitrary cell expression, and can be used much like a console for querying or modifying the landscape state.

			*e) '''Align Layer''': The Align Layer feature aligns the currently selected layer with the layer chosen in the “Align with Layer” drop-down list by matching their georeferencing. If the layers are already aligned, no action is performed. If the layers are not aligned, then a new view is created with the name “alignedMAP”, where "MAP" is the name of the view chosen to align. The georeferencing of the new view will match the view chosen in the “Align with Layer” drop-down list. The contents of the new view will be the original view clipped to the new georeferencing. Any cells within the clip region, but not covered by the original layer will have a value of zero.
			*:Models in SELES must be aligned to run properly. That is, all raster layers must have the same extent (number of rows and columns) and must represent the same geographic location. This permits simulations to access all relevant information for a cell with a single location index.
			*:Once the layer to align with has been selected, the top-left and bottom-right bounds of the original image are shown relative to the georeferencing of the “Align with Layer”. These are called the aligned bounds. Any portion of the layer outside the range of the "Align with Layer" is clipped. Once an appropriate "Align with Layer" has been selected, the operation is performed by pressing the OK button.

			*f)'''Resize Layer''': The Resize Layer feature allows a raster to be resized, without changing its resolution. The dialog allows users to enter new bounds (top, left, bottom, right) for the raster. When the OK button is pushed, a new view with the same name but prefixed with “Resized” is created for the resized raster.

Fei: /* Static Models Menu */

2006-11-03T21:46:23Z

Static Models Menu

← Older revision		Revision as of 21:46, 3 November 2006
Line 155:		Line 155:
	**xii) '''Variable and Viewname drop-down lists''': the names of the views (windows) for layer variables used by the cell expression. For example, if the cell expression requires a layer variable called “topography”, then this variable will appear in the Variables list. This will map to view that contains topography in the Viewnames list.		**xii) '''Variable and Viewname drop-down lists''': the names of the views (windows) for layer variables used by the cell expression. For example, if the cell expression requires a layer variable called “topography”, then this variable will appear in the Variables list. This will map to view that contains topography in the Viewnames list.
	**xiii) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .sm suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These site model files can be opened directly using the Open menu item in the Files menu described in section II.		**xiii) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .sm suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These site model files can be opened directly using the Open menu item in the Files menu described in section II.

			*d) '''Value (or Statistical Summary) Model''': Value (or summary) models produce a single value by summarizing a function (specified as a cell expression) that computes a value for each cell in the landscape. The resulting value is displayed in the dialog box when “Generate” is pressed.
			*:To compute a value model, set up the function, as described below, and press the Run button to compute from an input file or RunEdits to compute from the expression written in the edit box. When finished, the dialog can be close with the Cancel button.
			*:The following parameters can be used to express a value model:
			**i) '''Operation''': Chose the desired summary function: mean, minimum value, maximum value, sum over all values, product over all values, nth root over all values (where n is the number of values computed).
			**ii) '''Cell Expression''': The file name of a cell expression to evaluate for computing the value for each site.
			**iii) '''Region''': The region is always the entire landscape. The edit box associated with the region allows users to specify a decision to limit the computation to a specific portion of the landscape.
			**iv) '''Variable and Viewname drop-down lists''': the names of the views (windows) for layer variables used by the cell expression. For example, if the cell expression requires a layer variable called “topography”, then this variable will appear in the Variables list. This will map to view that contains topography in the Viewnames list. When opened, all current views are automatically linked to variables of the same name.
			**v) '''Cell Expression Edit box''': This box allows users to type in an arbitrary cell expression, and can be used much like a console for querying or modifying the landscape state.

Fei: /* Static Models Menu */

2006-11-03T21:44:33Z

Static Models Menu

← Older revision		Revision as of 21:44, 3 November 2006
Line 119:		Line 119:
	**xi) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .nm suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These neutral model files can be opened directly using the Open menu item in the Files menu described in section II.		**xi) '''Load from File/Save to File''': Load model parameters from or save to the file specified in the adjacent text box. These files generally should have a .nm suffix. It is useful to load pre-existing model files, modify them to suit the current needs and then save these to a new file. These neutral model files can be opened directly using the Open menu item in the Files menu described in section II.

	*b) Fractal Model: Fractal models are landscape pattern models generated using a stochastic mid-point replacement algorithm, based on Mandelbrot’s fractal geometry. A number of controls are provided to influence various aspects of the pattern generation process. In addition, the values for zero or more fixed control points can be specified to “pin” down the landscape at various locations. These fractal landscape pattern models often exhibit characteristics similar elevation maps, and thus are often used as synthetic digital terrain models (DEMs).		*b) '''Fractal Model''': Fractal models are landscape pattern models generated using a stochastic mid-point replacement algorithm, based on Mandelbrot’s fractal geometry. A number of controls are provided to influence various aspects of the pattern generation process. In addition, the values for zero or more fixed control points can be specified to “pin” down the landscape at various locations. These fractal landscape pattern models often exhibit characteristics similar elevation maps, and thus are often used as synthetic digital terrain models (DEMs).
	*:To produce instances of a fractal model, set up the constraints, as described below, and press the Generate button. When finished, the dialog can be close with the Cancel button.		*:To produce instances of a fractal model, set up the constraints, as described below, and press the Generate button. When finished, the dialog can be close with the Cancel button.
	*:The following are the constraints that can be used to express a fractal model:		*:The following are the constraints that can be used to express a fractal model: