Environment Commands

Working Directory

The working directory is the current directory where journal files are saved. To list the current directory type

pwd

The current path will be echoed to the screen. By default, the current directory is the directory from which CUBIT was launched.   The command to change the current directory is

cd "<new_path>"

The new path may be an absolute reference, or relative to the current directory.   The <TAB> key will complete unique file references.

File Manipulation

A helpful addition is the ability to do a directory listing of a directory. The command for this is

ls ['<file_name>']

or

dir ['<file_name>']

Note also that you can delete files from the command line. The command for this is

Delete File ['<file_name>']

The file name may include the wildcard character *, but not the wildcard character ?, since the ? is used for command completion. File deletion from the command line can also be disabled. If deletions are set to off files cannot be deleted from the cubit command line.

Set Deletions [ON|Off]

The mkdir command is used to create a new directory. The syntax for this command is:

Mkdir "<directory_name>"

This creates a new directory with the specified name and path. The command accepts an absolute path, a relative path, or no path. If a relative path is specified, it is relative to the current working directory, which can be seen by typing 'pwd' at the cubit command prompt. If no path is specified, the new directory is created in the current working directory.

The command succeeds if the specified directory was successfully created, or if the specified directory already exists. The command fails if the new directory's immediate parent directory does not exist or is not a directory.

CPU Time

At times it is important to see how much cpu time is being used by a command.   One function available to do this is the timer command.   The syntax for this command is:

Timer [Start|Stop]

The start option will start a CPU timer that will continue until the stop command is issued. The elapsed time will be printed out on the command line. If no arguments are given, the command will act like a toggle.

Comment

This keyword allows you to add comments without affecting the behavior of CUBIT.

Comment ['<text_to_print>'] [<aprepro_var>] [<numeric_value>]

The comment command can take multiple arguments. If an argument is an unquoted word, it is treated as an aprepro variable and its value is printed out. Quoted strings are printed verbatim, and numbers are printed as they would be in a journal string. For example:

CUBIT> #{x=5}
CUBIT> #{s="my string"}
CUBIT> comment "x is" x "and s is" s

User Comment: x is 5 and s is my string

Journaled Command: comment "x is" x "and s is" s

History

This command allows you to display a listing of your previous commands.

History <number_of_lines>

For example, if you type history 10, the most recent 10 commands will be echoed to the input window.

Error Logging

[set] Logging Errors {Off | On File '<filename>'[Resume]}

This setting will allow users to echo error messages to a separate log file. The resume option will allow output to be appended to existing files instead of overwriting them. For more information on CUBIT environment settings see List Cubit Environment.

Determining the CUBIT Version

To determine information on version numbers, enter the command Version. This command reports the CUBIT version number, the date and time the executable was compiled, and the version numbers of the ACIS solid modeler and the VTK library linked into the executable. This information is useful when discussing available capabilities or software problems with CUBIT developers.

Echoing Commands

By default, commands entered by the user will be echoed to the terminal. The echo of commands is controlled with the command:

[Set] Echo {On | Off}

Digits Displayed

CUBIT uses all available precision internally, but by default will only print out a certain number of digits in order for columns to line up nicely. The user can override that with the "set digits" command:

Set Digits [<num_to_list=-1>]

If the digits are set to -1, then the default number of digits for pretty formatting are used. If the digits are set to a specific number, such as 15, more digits of accuracy can be displayed. This may be useful when checking the exact position and size of geometric features.

The number of digits used for listing positions, vectors and lengths can be listed using the following command:

List Digits

Examples:

CUBIT> set digits 6

Coordinates and lengths will be listed with up to 6 digits.

CUBIT> set digits 20

For this platform, max digits = 15. Coordinates and lengths will be listed with up to 15 digits.

CUBIT> set digits -1

To reset digits to default, use 'set digits -1'

The number of coordinate and length digits listed will vary depending on the context.