Welcome

This help system documents dialog box that are implemented by Enthought libraries.


Converge Connection Editor Dialog Box

To access this dialog box: Double-click a chip in the Dataflow tab of a model window.

Use this dialog box to edit the names of a chip, its bundles, and its ports. You can also move ports to different bundles and hide or show output ports.

The box on the left side of the dialog shows the hierarchy of the chip, with subfolders for inputs and outputs, bundles, and ports.

  • You can expand the hierarchy and select items within it.

  • You can drag a port to a different bundle of the same type (input or output).

Name: The name of the selected item. Use this field to edit the name of the item.

Visible: This checkbox is available only for output bundles and ports. If it is selected, the item is visible in the model window tabs. If it is cleared, the item is not visible in the model window, but it is still visible in the Navigator tab.


Create a New Log Dialog Box

To access this dialog box: In the Inputs tab of a model window, select an input port that represents a log, and click Create Log in the bottom panel.

Use this dialog box to create a new constant log, which will be used as the value of an input port.

Index: The index log to use for the new log. Drag an index log from the Navigator tab onto this field. The name of the index log appears in this field, and the name of the log suite that the index belongs to appears for Log suite. This field may be pre-filled, if you dragged a depth index to the Depth Index field on the Inputs tab of the model window.

Log suite: The log suite that the new log will be added to. This field is filled in when you drop an index log on the Index field.

Log name: The name for the new log.

Value: The constant value to use for the new og.

Units: The units of the new log. The options for this field depend on the units required by the input port.

Family: The unit family of the new log. This field is filled based on the units required by the input port.

Units system: The units system designated for the port. This information is used by the program when converting data between connected ports.


Customize Filters Dialog Box

To access this dialog box: In the View list of the Inputs tab or Outputs tab of a model window, select Customize.

Use this dialog box to create, edit, and delete filters for a table of input or output ports.

The list on the left side of the dialog box contains names of filters that can be applied to the table. Select a filter in the list, and then click one of the buttons on the right to operate on it.

Edit: Opens the Edit filter dialog box so you can modify the selected filter.

New: Creates a new filter based on the selected filter, and opens the Edit filter dialog box so you can modify the new filter.

Apply: Applies the selected filter to the table. Only items that meet the filter criteria are displayed in the table.

Delete: Deletes the selected filter.

NOTE: You cannot edit or delete the filter named Filter template.


Edit Filter For Inputs Dialog Box

To access this dialog box:

  1. In the View list of the Inputs tab of a model window, select Customize. The Customize Filters dialog box opens.

  2. Select the Evaluation filter template, or a filter based on it, and click New or Edit.

Use this dialog box to specify criteria for a filter for the table of output ports on the Outputs tab of a model window. When a filter is applied to the table, only the input ports that match the criteria of the filter are displayed in the table.

Function name contains: A string to search for in the function (chip) name.

Input name contains: A string to search for in the input port name.

Guidance: A string to search for in the Guidance field of the input port.

Connected: Select one of the following:

  • Don't care: The connection status of the input port does not affect the search.

  • Connected

  • Not connected


Edit Filter For Outputs Dialog Box

To access this dialog box:

  1. In the View list of the Outputs tab of a model window, select Customize. The Customize Filters dialog box opens.

  2. Select a filter and click New or Edit.

Use this dialog box to specify criteria for a filter for the table of output ports on the Outputs tab of a model window. When a filter is applied to the table, only the output ports that match the criteria of the filter are displayed in the table.

Function name contains: A string to search for in the function (chip) name.

Output name contains: A string to search for in the output port name.


Edit Menu-Based Filter Dialog Box

To access this dialog box:

  1. In the View list of the Inputs tab of a model window, select Customize. The Customize Filters dialog box opens.

  2. Select the Menu-based filter template, or a filter based on it, and click New or Edit.

Use this dialog box to specify criteria for a filter for a table. When a filter is applied to the table, only the input ports that match the criteria of the filter are displayed in the table.

Filter name: The name of the filter. This name is dynamically constructed, based on the rules specified, unless you explicitly type a new name.

The dialog box contains a table of rules, with one rule for each attribute on the items being filtered. The values for the rules are based on the item that is currently selected in the table being filtered. The rule table contains the following columns:

(Unlabeled): Indicates whether the rule is enabled. When a rule is enabled "==>" appears in the cell. To modify the value, click the cell once to select it, and then click again to edit it (do not double-click). A check box appears in the cell. Click to select or clear the check box.

Name: An attribute on the type of object being filtered. You can select a different name from a drop-down list.

Operation: A Boolean operation relating the Name to the Value. You can select a different operation from a drop-down list.

Value: A value to be related to the Name.

To add a rule to the table, click the Insert new item ( [image]) icon, and then modify the cells of the row to define the rule.

To delete a rule, select it and click the Delete current item ( [image]) icon.


Edit Rule-Based Filter Dialog Box

To access this dialog box:

  1. In the View list of the Inputs tab of a model window, select Customize. The Customize Filters dialog box opens.

  2. Select the Rule-based filter template, or a filter based on it, and click New or Edit.

Use this dialog box to specify criteria for a filter for a table. When a filter is applied to the table, only the input ports that match the criteria of the filter are displayed in the table.

Filter name: The name of the filter. This name is dynamically constructed, based on the rules specified, unless you explicitly type a new name.

The dialog box contains a table of rules, which may be empty. The table contains the following columns:

or: Indicates whether the rule should be conjoined ("ANDed") or disjoined ("ORed") with other rules in the table.

Name: A field on the type object being filtered.

Operation: A Boolean operation relating the Name to the Value.

Value: A value to be related to the Name.

To add a rule to the table, click the Insert new item ( [image]) icon, and then modify the cells of the row to define the rule.

To delete a rule, select it and click the Delete current item ( [image]) icon.


Filter Templates

When you create a filter for the Inputs table or the Outputs table in a dataflow window, you can base the filter on another filter, or on a filter template. A filter template is like a normal filter, but it cannot be changed or deleted. In addition, the appearance of the Edit filter dialog box changes depending on the type of template that a filter was created from.

The following types of filter templates are available:

  • Evaluation: This template lets you define an arbitrary Python expression. Only items for which the expression is true will be displayed in the table.

  • Rule-based: This template lets you define a set of rules that compare an attribute of the items in the table to a specified value. The available operations include numeric and string comparisons. You can combine multiple rules by conjoining ("AND") or disjoining ("OR") them. Only items for which the set of rules is true will be displayed in the table. See Edit Rule-Based Filter Dialog Box.

  • Menu-based: Similar to the rule-based template, this template pre-defines one rule for every attribute of the items in the table. You can modify the rules and enable or disable them. Only items for which the enabled rules are true will be displayed in the table. See Edit Menu-Based Filter Dialog Box.

  • Filter template: This template lets you set values for criteria that are pre-defined based on the type of item being filtered. Only items that match the specified criteria will be displayed in the template. See:

    • Edit Filter For Inputs Dialog Box

    • Edit Filter For Outputs Dialog Box


Function Browser Dialog Box

Use this dialog box to view and select functions.

Available Functions: Displays names and descriptions of available functions. Click a function to select it.

Inputs: Displays input parameters for the selected function.

Outputs: Displays output parameters for the selected function.

Code: Displays the code that defines the function.

You can change the width of columns in the Available Functions, Inputs, or Output lists:

  1. Position the pointer over the edge of a column header (for example, between Name and Description). The pointer changes to a double-headed arrow.

  2. Drag the column boundary to adjust the column width.


Logger Pane

The Logger pane displays messages from the application, including the type, date, and time of the message. If the application does not behave as expected, especially with respect to generating data, check this tab to see whether an internal error occurred.

The following message types, in order of severity, may be used:

  1. DEBUG: A message of interest to programmers.

  2. INFO: High-level program status or progress information.

  3. WARNING: A message about problem involving data. This message type does not indicate a problem with the program's operation.

  4. ERROR: Information about an internal error. This message type usually indicates a bug in the program or a major configuration problem.

  5. CRITICAL: Information about an error so severe that it impairs the program's ability to continue, and may cause the program to exit (for example, running out of memory).

If you double-click an entry in the Output tab, a Quality Agent dialog box appears, displaying the text of the message. This is useful for viewing long messages, such as Python traceback error messages, and for reporting errors to Enthought.

To clear all the entries in the Output tab, right-click anywhere in the list of messages.

Messages are also written to a file, envisage.log, in your home directory. (On MS Windows, your home directory is typically C:\Documents and Settings\username.) When this file grows to about 1000 KB, it "overflows" to a back-up file, envisage.log.1; up to 3 back-up files are maintained, for a total of up to 4 MB of log entries for the current session.


Model Window

  • Chips

  • Model Window Dataflow Tab Toolbar

  • Model Window Inputs and Outputs Tabs Toolbar

  • Search for Inputs Dialog Box

  • Select and Order Columns Dialog Box

  • Model Window Inputs and Outputs Tabs Toolbar

  • Search for Outputs Dialog Box

  • Select and Order Columns Dialog Box

Model Window

To access this window: Open a model.

The model window contains the following tabs:

  • Dataflow

  • Inputs

  • Outputs

  • Optimization

Dataflow Tab

The Dataflow tab contains a toolbar and a "canvas" or work area for arranging and connecting chips for a model.

Related Topics:

Inputs Tab

The Inputs tab contains a table that lists input ports of the chips currently in the model. You can apply filters to restrict the list of input ports displayed.

If the input port that is selected in the table requires a well log, a panel appears in at the bottom of the window, showing the name of the log (if any) that is associated with the input port. You can drag a well log from the Navigator tab onto the Log name field, or click Create Log to create one on the spot.

Related Topics:

Outputs Tab

The Outputs tab contains a table that lists output ports of the chips currently in the model. You can apply filters to restrict the list of output port displayed.

Related Topics:


Model Window Dataflow Tab Toolbar

The toolbar of the Dataflow tab of a model window contains the following buttons:

Icon | Label | Description
 | Undo | Undoes the last change you made.
 | Redo | Redoes the last change you undid.
 | Run | Executes the model.
 | Edit | Opens the Converge Connection Editor dialog box, so you can modify the chip.
 | Delete | Deletes the currently selected item.
 | Collapse | Consolidates the selected chips into a single, composite chip.
 | Expand | Expands a composite chip into its sub-chips.
 | Min | Changes all chips in the model window to their minimized form.
 | Normal | Changes all chips in the model window to their normal form.
 | Max | Changes all chips in the model window to their maximized form.
 | Left | Left-aligns the selected chips.
 | Center | Aligns the selected chips on their horizontal centers.
 | Right | Right-aligns the selected chips.
 | Top | Top-aligns the selected chips.
 | Center | Aligns the selected chips on their vertical centers.
 | Bottom | Bottom-aligns the selected chips.
 | Horz. | Distributes the selected chips evenly horizontally.
 | Vert. | Distributes the selected chips evenly vertically.


Model Window Inputs and Outputs Tabs Toolbar

The Inputs tab and Outputs tabs of a model window contain a toolbar with the following icons:

Icon | Action | Description
 | Do not sort columns | Removes any sort order from the columns and returns them to the original order.
 | Search table | Opens a Search for dialog box, which helps you search for items.
 | Set user preferences for table | Opens a Select and order columns dialog box, which lets you select the attributes of items, and set the order in which they are displayed.


Model Window Optimization Tab

To access this tab:

  1. Open a model window.

  2. Click the Optimization tab.

The Optimization tab of the model window allows you to specify settings for and run an optimization of a model.

The tab contains the following areas:

  • General settings area: Fields for basic settings for the optimization.

  • State Variables sub-tab: Allows you to select logs to be used as "state variables" in the optimization, in other words, inputs whose values are to be optimized.

  • Comparison Targets sub-tab: Allows you to specify measured logs and calculated logs that the optimization should compare to one another.

  • Constraints sub-tab: Allows you specify upper and lower bounds for state variables or script-generated values.

  • Run Optimization: Click to run the optimization after you have specified all the necessary settings.

General Settings

Error Tolerance: The level of inaccuracy that is acceptable in the optimization. The greater the error tolerance, the faster the speed of the optimization.

Maximum Iterations: The maximum number of iterations that the optimization should execute to find results.

Log Suite: A log suite containing measured logs to use as state variables and in comparison targets. Drag a log suite node from the Navigator tab to this field.

Starting depth: The top depth of the range over which to optimize.

Ending depth: The bottom depth of the range over which to optimize.

State Variables

Available Logs: Logs that are available to be used as state variables. This box is populated when you specify a Log Suite.

Selected: Logs that will be used as state variables in the optimization.

>: Click to move a selected log from Available Logs to Selected.

<: Click to move a selected log from Selected to Available Logs.

Comparison Targets

This sub-tab contains a table of comparison targets, which are a measured log, a calculated log to compare to it, and a weighting of the comparison.

Click to add another row to the table.

Click to delete the selected row.

Active: Whether this target is used in the optimization.

Measured Log: A measured log to compare against. This list is populated from the specified Log Suite.

Calculated Log: A calculated log to compare to the measure log. The list is populated from the output ports in the model.

Relative Weighting: A float value representing the relative importance of this target in calculating the optimization. A weight of 1.0 is twice as important as a weight of 0.5.

Constraints

This sub-tab contains a table of constraints that must remain satisfied by the optimization's solution.

Click to add another row to the table.

Click to delete the selected row.

Active: Whether this constraint is used in the optimization.

Minimum Value: A lower bound for the constraint.

Oper: An operator comparing the Minimum Value to the middle term. If set to None, the constraint has no lower bound.

State Variable or Constraint Script: A state variable (from those in the Selected column on the State Variables sub-tab) or a constraint script.

Oper: An operator comparing the middle term to the Maximum Value. If set to None, the constraint has no upper bound.

Maximum Value: An upper bound for the constraint.

Relationship between expressions: Indicates how the constraint expressions are composed.


Quality Agent Dialog Box

To access this dialog box: Double-click an entry in the Logger pane.

Use this dialog box to send feedback to the developers of CP Lab.

Message: Contains the full text of the Logger entry.

Subject: Type a summary of your message.

To: The address to send the message to. The default address sends it to the issue-tracking system for CP Lab.

Cc: Type an e-mail address for anyone else you wish to notify.

From: Type your own e-mail address.

SMTP Server: Enter the name of a mail server for your organization.

How critical is this issue? Select one of the following options:

  • Low: A minor problem, or one that has an easy workaround.

  • Medium: A problem where the program is not working as intended or expected.

  • High: A problem that significantly interferes with your ability to use the application, and has no workaround.

  • Critical: A problem that prevents you from using the application, and has no workaround.

Additional Comments: Type your comments about the program.

Include Workspace File: Select this to attach a copy of your current project to the e-mail message. If an error depends in some way on your specific data, attaching the project file helps developers reproduce the problem.

Send: Click to send an e-mail message.

Cancel: Click to close the dialog box without sending an e-mail message.

NOTE: The program sends an e-mail message only if your computer is connected to the Internet, and has access to the SMTP Server you select.


Script Window

To access this window, right-click an action icon in the Actions pane, and click Edit Action on the shortcut menu.

A script window allows you to modify Python code and define metadata for a script. It contains the following panes:

  • Code

  • Parameters

  • Buttons

NOTE: The Code, Parameters, Inputs, and Outputs tabs are all "dockable". You can drag a tab to a different location within its containing window, such as side-by-side, vertically stacked, or layered; you can even drag a tab outside its containing window to make it a separate window. However, you cannot drag the Inputs or Outputs tab into the Code tab, as the Code tab cannot contain other tabs.

Code Pane

The Code pane contains a text editor region for editing the body of the script. It provides syntax coloring for Python code.

Parameters Pane

The Parameters pane contains "metadata" elements that enable a script to be used as an action in a model.

Inputs Tab: A table of definitions for input parameters for the action. Each input parameter usually corresponds to an argument of a function defined in the script.

Outputs Tab: A table of definitions for output parameters for the action. Each output parameter usually corresponds to a return value of a function defined in the script.

You can specify the following information for each input and output parameter:

  • Arg Name: The name of the argument or return value that corresponds to the parameter.

  • Default: The default value for the parameter.

  • Description: A description of the parameter.

  • Port Name: The name of the parameter, for purposes of matching other variables. This name typically corresponds to a log name.

  • Modifier: An optional modifier for the parameter name. A modifier often indicates a condition regarding a log, such as "oil", "gas", or "wet".

  • External Type: The datatype of the value expected (for inputs) or produced (for outputs) by the parameter.

  • Internal Type: The datatype of the value expected (for inputs) or produced (for outputs) internally by the function in the script.

  • Units: The unit for the value.

  • Family: The quantity described by the units of the value, for example, density.

  • Units System: The system of measure that the unit belong to. The units system determines the resulting units for calculated values.

  • Bundle: The name of the bundle that the parameter belongs to.

Click the Set user preferences for table ( [image]) icon to open the Select and Order Columns dialog box, to choose the columns to display and the order to display them in.

Buttons

Save: Save any changes to the script code or metadata.

Run: Execute the script.

Auto populate: Generate rows for the Inputs and Outputs tables, based on the parameters and return values of the function in the script. You can modify the information in the rows after it is generated.


Search for Inputs Dialog Box

To access this dialog box: Click the Search table icon ( [image]) on the Inputs tab of a model window.

Use this dialog box to search for and select input ports that meet criteria that you specify.

Function name contains: A string to search for in the function (chip) name.

Input name contains: A string to search for in the input port name.

Guidance: A string to search for in the Guidance field of the input port.

Connected: Select one of the following:

  • Don't care: The connection status of the input port does not affect the search.

  • Connected

  • Not connected

Find Next: Selects the next (lower) item that meets the search criteria.

Find Previous: Selects the previous (higher) item that meets the search criteria.

Select: Selects all the items that meet the search criteria.

Close: Closes the dialog box.


Search for Outputs Dialog Box

To access this dialog box: Click the Search table icon ( [image]) on the Outputs tab of a model window.

Use this dialog box to search for and select output ports that meet criteria that you specify.

Function name contains: A string to search for in the function (chip) name.

Output name contains: A string to search for in the output port name.

Find Next: Selects the next (lower) item that meets the search criteria.

Find Previous: Selects the previous (higher) item that meets the search criteria.

Select: Selects all the items that meet the search criteria.

Close: Closes the dialog box.


Select and Order Columns Dialog Box

To access this dialog box: Click the Set user preferences for table icon in the Inputs tab or Outputs tab of a model window.

Use this dialog box to choose columns to display in a model window Inputs tab or Outputs tab, and to specify their order.

The list on the left side of the dialog box contains names of columns that are not currently displayed in the tab.

The list on the right side contains names of columns that are currently displayed, in the order that they are displayed.

Use the buttons to move names between the list, and to reorder the right-hand list.

>: Move the name that is selected in the left-hand list to the position above the selection in the right-hand list.

<: Move the name that is selected in the right-hand list to the position above the selection in the left-hand list.

Move up: Move the name that is selected in the right-hand list up by one position. The corresponding column in the table moves to the left by one position.

Move down: Move the name that is selected in the right-hand list down by one position. The corresponding column in the table moves to the right by one position.

As names are added, removed, or reordered in the right-hand list, the columns in the table change immediately.


Workflow Properties Dialog Box

To access this dialog box: Double-click a workflow node under Workflows or Cases in the ProAVA2 Explorer tab.

Use this dialog box to change settings for workflows (a case is a type of workflow).

CAUTION: It is possible to construct a workflow that cannot be executed. An invalid workflow causes an error message when you try to open a Synthetic View or Simulation View window. It is a good idea to make a back-up copy of your project before changing a valid workflow.

Functions: On the left side of the dialog box is a list of functions that implement the workflow. Select a function name to display its parameters on the right side of the dialog box.

Inputs: The fields in this area vary, depending on the function selected. The field names are parameter names, and the values are literal values or variable names.

Outputs: The field in this area varies, depending on the function selected. The field name is a description of the output, and the field value is a variable name, which can be used in the input fields of other functions.

Buttons for functions:

Button | Description
 | Opens the Function Browser dialog box, so that you can select a function to add to the workflow.
 | Deletes the selected function from the workflow.
 | Moves the selected function up in the function list.
 | Moves the selected function down in the function list.
 | Enables the selected function, if it is disabled.
 | Disables the selected function, if it is enabled.

Related Topics:


Changing a Workflow

You can change the following aspects of a workflow or case:

  • Parameter values for functions

  • Add or remove functions in the workflow

  • Enable or disable functions in the workflow

  • Change the order of functions in the workflow

CAUTION: It is possible to construct a workflow that cannot be executed. An invalid workflow causes an error message when you try to open a Synthetic View or Simulation View window. It is a good idea to make a back-up copy of your project before changing a valid workflow.

To change a workflow:

  1. Double-click a workflow or case node in the ProAVA2 Explorer tab. The Workflow Properties dialog box appears.

    • To change the inputs to a function, select the function on the left side of the dialog box, and edit the input values on the right side of the dialog box.

    • To add a function, click [image], and then select a function in the Function Browser dialog box.

    • To remove a function, select the function on the left side of the dialog box, and click [image].

    • To change the order of functions, click [image] to move the selected function up, and click [image] to move the selected function down. The functions execute in the order that they are listed.

    • To disable a function, select the function and click [image]. The word "(disabled)" appears next to the function name in the function list. Disabling prevents the function from executing, without removing it from the workflow definition.

    • To enable a disabled function, select it and click [image]. The word "(disabled)" disappears from next to the function name.

  2. Click OK when you are finished making changes.