Welcome

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


Logger Tab

The Logger tab 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 Logger 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 Logger 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.


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.


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 script window.

Use this dialog box to choose columns to display in a script 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.