Title Page
Legal Notice
Table of Contents
Introduction
Requirements
Design
Quality Assurance and Testing
|
Requirements of the Simulation Editor
The FRAMEwork System (FRAMES) includes a suite of editors designed to manage, view, and set up the underlying infrastructure as well as run a simulation. The five editors, each with its own documentation, include the following:
- Conversion Editor, which manages measures and units used by dictionaries and datasets to automatically convert between different mediums
- Dictionary Editor, which creates and edits dictionaries used by FRAMES to categorize data
- Module Editor, which creates and manages the modules that manipulate data by specifying dictionaries
- Domain Editor, which organizes a palette of modules from which to select for a particular simulation
- Simulation Editor, which sets up and runs a particular simulation.
This section summarizes requirements for the Simulation Editor. Those interested in setting up a risk scenario and analyzing data should refer to the start up documentation for additional information. Those interested in importing a module into FRAMES should refer to the importation documentation for additional information.
The Simulation Editor has the following general requirements:
- Allow the user to create, access, and save simulation (*.sim) files.
- Allow the user to pictorially develop the conceptual site model (CSM) for the scenario.
- Provide online help on how the Simulation Editor operates.
- Allow the user to select from icons representing the available model types (e.g., constituents, source, vadose, aquifer, surface water, air, overland, intake, exposure, impacts, and sensitivity/uncertainty) to develop the conceptual picture of the problem.
- Provide the user with a signal light indicating the status of each module associated with the scenario.
- Provide data viewers to allow users to view text and graphical information produced by any module that adheres to FRAMES data file specifications.
- Provide error messages or prevent the user from linking modules inappropriately or when module selections occur.
- Display module-provided error messages to the user when operating modules inappropriately.
- Provide a drag and drop system to add or remove connections between the modules in the diagram.
- Follow module descriptions to allow only appropriate linkages between modules to develop a sull simulation.
- Allow the user to delete a module icon by selecting "Delete" from its right-click context menu.
- Provide a "Go" button to run all modules associated with a simulation.
- Allow the user to customize the description of the simulation by changing the label for each module.
- Allow the user to close a simulation file with or without saving changes.
- Allow the user to print the CSM, module descriptions, and user inputs.
- Have the look and feel of Windows.
- Display the available models as icons organized by class and group (e.g., module type) within a domain as described in each module description file. Allow the user to change icons.
- Allow the user to define the user interface font, colors, and logo.
- Read a set of domains from the Startup.ini file and display it to the user in the module pallette.
- Allow for execution of the simulation as a FRAMES component.
- Implement the ability to lock the models, the connections, or both.
- Allow the user the ability to add tiered icons to the icon pallette. Perform some testing and update any documentation associated with this updated functionality.
- Allow the user to enter some information about a model that will easily be viewable in the user's work space. Update the User Interface so the user has the option of creating a sticky note for each module. The sticky note will provide the user with the ability to enter desired text and document a personal note.
|