Overview

Overview

This guide provides user documentation for WRIMS 3 GUI. It covers the core tasks and interface features required to load and configure studies, navigate the workspace, inspect model structure, debug model behavior, run special execution workflows, and review DSS-based results.

The guide is organized to support both task-based use and general reference. Conceptual sections explain key interface elements, configuration behavior, and model-navigation features, while procedural sections provide step-by-step instructions for common workflows.

This document is intended to support both first-time users and experienced study developers. It may be used as:

• an onboarding guide for common WRIMS 3 GUI tasks;

• a reference for interface behavior, launch configuration, and model navigation;

• a procedural guide for debugging, analysis, cleanup, special executions, and DSS review.

Intended audience

This guide is intended for:

• New users who need a clear starting point for loading studies, creating launch files, and understanding the WRIMS 3 GUI workspace;

• Study developers and analysts who need to run, inspect, compare, and troubleshoot WRIMS studies; and

• Advanced users who need batch execution, multi-study workflows, position analysis, and DSS-based result review.

How to use this guide

• If you are new to WRIMS 3 GUI, start with Chapter 1. Getting Started, then continue to Chapter 2. Concepts and Interface.

• If you need to inspect model behavior during execution, go to Chapter 4. Core Debugging Workflow.

• If you need to compare runs, filter goals, or analyze forced reruns, go to Chapter 5. Analysis and Diagnostics.

• If you need to package studies or create clean study copies, go to Chapter 6. Study Cleanup and Packaging.

• If you need batch execution, multi-study runs, position analysis, or sensitivity runs, go to Chapter 7. Special Executionss.

• If you need to review DSS data and compare DSS records, go to Chapter 8. DSS Review and Results.

Common terms

• Study: a WRIMS project and its associated files used for a model run.

• Launch file: the WRIMS run or debug configuration that stores model paths, DSS settings, dates, and execution options.

• DV DSS / SV DSS / Initial DSS: DSS files used for decision-variable output, state-variable input, and initial-condition input.

• Cycle: an internal model iteration at a given time step.

• Controlling goal: a goal that is currently binding, as indicated in the GUI by the controlling-goal marker.

• Perspective: a task-oriented arrangement of views and tools in the WRIMS interface.

Table of contents

• 1. Getting Started

  • 1.1 Basic Load Existing Study

  • 1.2 Basic New Study

  • 1.3 Basic Load Zip File

  • 1.4 Basic Create Launch File

  • 1.5 Basic Modify Launch File

• 2. Concepts and Interface

  • 2.1 Existing Studies and New Studies

  • 2.2 Launch Files and Run Modes

  • 2.3 Variable and Goal Views

  • 2.4 Controlling Goals and Goal Tolerance

  • 2.5 Basic Perspectives

  • 9.1 Schematic View Workflow

  • 9.2 Schematic Editor Workflow

  • 2.6 Basic Outline Panel for the WRESL File

• 3. Model Structure and Source Navigation

  • 3.1 Basic WRESL Plus

  • 3.2 Debug Find Reference

  • 3.3 Debug Study Cycle WRESL

• 4. Core Debugging Workflow

  • 4.1 Debug Pause Variable Goal View

  • 4.2 Debug Variable Monitor

  • 4.3 Debug Variable Detail

  • 4.4 Debug Watch Variables Goals

  • 4.5 Debug Solver And Option

  • 4.6 Debug Error Source Code Link

  • 4.7 Debug Conditional Breakpoint

• 5. Analysis and Diagnostics

  • 5.1 Debug Compare Existing Studies

  • 5.2 Debug Filter Goals

  • 5.3 Debug Force Variable Resimulation

• 6. Study Cleanup and Packaging

  • 6.1 Debug Clean SV DSS File

  • 6.2 Debug Clean Study

• 7. Special Executions - 7.1 Special Batch Run GUI - 7.2 Special Batch Run Cmd - 7.3 Special Multi Study Run - 7.4 Special Position Analysis - 7.5 Sensitivity Analysis in WRIMS

• 8. DSS Review and Results

  • 8.1 DSS Wrims DSS Perspective

• 9. Schematic Workflows

  • 9.1 Schematic View Workflow

  • 9.2 Schematic Editor Workflow