Job Options¶

Job options are listed here with the names that appear in the CONVERGE Horizon web interface. Some options have slightly different names in CONVERGE Studio, and some options are not yet available in CONVERGE Studio.

Details¶

Details > Job Name¶

The name of the job you are running. The job will be listed with this name on the Jobs page.

Details > Associated Project¶

The project to associate with the job.

Details > Optional Batch¶

The batch to which the job will be added. Leave blank if the job is not part of a batch.

You can add jobs only to your own batches (i.e., batches you created).

Details > Storage Path¶

The path to the directory containing the input files. This option appears only if you are using a file system for storage.

Click Browse to select a directory from the file system. Paths selected in the Browse Directories modal are relative to /mnt/fs/files. If you enter the path manually, you can provide the path relative to /mnt/fs/files or /mnt/fs, or you can provide the full path.

You can run only one job at a time from a given storage path.

CONVERGE¶

CONVERGE > Version¶

The CONVERGE version to run.

If you are running CONVERGE 2.3 or 2.4, extra steps are required as described here.

CONVERGE > License¶

The type of license that will be used to run CONVERGE.

On-Demand:: Pay for a CONVERGE license by the job-hour based on your subscription tier (default).
Horizon-Hosted:: Use a CONVERGE license hosted on CONVERGE Horizon. This option is available only if your organization has an existing CONVERGE license agreement and has arranged for the license to be hosted on CONVERGE Horizon. If you are interested pursuing this option for a new or existing CONVERGE license, contact your Convergent Science representative.
Self-Hosted:: Use a CONVERGE license hosted on your own license server. You can use this option only if your organization has completed the Self-Hosted License Setup. If you select this option, you must specify your license server details.

Note

There is no on-demand license charge for running the check_inputs utility. You can run check_inputs by specifying -u check_inputs in CONVERGE > Optional Arguments.

CONVERGE > Time Limit¶

The maximum number of hours that CONVERGE can run before it is stopped automatically.

CONVERGE > Optional Arguments¶

Extra command-line arguments to pass to CONVERGE. You can use this option to run chemistry utilities and other utilities for the CONVERGE solver.

Arguments for CONVERGE utilities typically have the format -u <utility name>. For more information, refer to the CONVERGE Manual, available on the Convergent Science Hub (login required).

CONVERGE > Optional Executable Name¶

File name of a custom executable that will be used to run the job. Leave blank to run the official release of the version you selected.

The CONVERGE Horizon runtime environment uses HPC-X MPI and glibc 2.28. Custom executables built with other MPI packages and/or newer glibc versions are not officially supported and are not likely to work.

If you specify a custom executable, it must be uploaded to the same directory as the input files. Select a CONVERGE version with the same MAJOR or MAJOR.MINOR version as the custom executable. (For example, you can select any 4.x.y version for a CONVERGE 4 executable. You can select any 3.1.x version for a CONVERGE 3.1 executable.) Note that a custom executable is required to run CONVERGE 2.3 or 2.4, as explained here.

CONVERGE > Optional Coupling¶

To run a co-simulation in which CONVERGE is coupled to another application, select the other application here. This option requires the use of a self-hosted license for the selected application (you can still use any license type for CONVERGE).

CONVERGE > Custom License Server¶

Port number and hostname of your CONVERGE license server, in the format 2765@hostname. This option applies only if you are using a self-hosted license for CONVERGE.

To confirm that CONVERGE Horizon is able to connect to your license server, click Test after entering the server information.

GT-SUITE¶

These options appear only if you specify optional coupling with GT-SUITE.

GT-SUITE > Version¶

The version of GT-SUITE to run.

GT-SUITE > Custom License Server¶

Port number and hostname of your GT-SUITE license server, in the format 27005@hostname.

To confirm that CONVERGE Horizon is able to connect to your license server, click Test after entering the server information.

GT-SUITE > Optional Arguments¶

Extra command-line arguments to pass to GT-SUITE.

Do not specify any of the following arguments: -v, -s, or -t. GT-SUITE might not start if these arguments are specified.

Hardware¶

Hardware > Node Type¶

The type of node (i.e., compute instance) that will be used to run the job. You can run jobs on bare metal (BM) servers or on virtual machines (VMs).

The availability of compute nodes at each data center fluctuates throughout the day. If your preferred node type currently has limited availability, you can still submit your job. We recommend setting a Maximum Queue Time of at least 24 hours to allow enough time for nodes to become available.

Hardware > Maximum Queue Time¶

The maximum number of hours you are willing to wait for hardware to be allocated. If the requested nodes cannot be allocated within this time, the job will fail.

If the Maximum Queue Time is 0, CONVERGE Horizon will request nodes only once (for multi-node jobs, this includes one full cycle, starting with the Target Number of Nodes and ending with the Minimum Number of Nodes). If hardware is not allocated, the job will fail immediately.

Hardware > Flex Cores¶

The number of cores that will be allocated to the virtual machine. Applies only to VM node types.

Hardware > Flex Memory¶

The amount of memory (in GB) that will be allocated to the virtual machine. Applies only to VM node types.

By default, this value increases linearly as the number of Flex Cores increases. You can override the default value as needed. Some simulations may require more memory than the default value.

Hardware > Target Number of Nodes¶

The target number of nodes that you want for the job. Applies only to node types that allow multiple nodes per job.

When the job is created, CONVERGE Horizon starts by requesting the target number of nodes from the cloud provider. If the target number is not available, CONVERGE Horizon will subtract one node and try again. This process is repeated until nodes are allocated or the Minimum Number of Nodes is reached. If the minimum number is not available, the process starts over with the target number and continues until nodes are allocated or the Maximum Queue Time has elapsed.

For example, if the target number is 5 and the minimum number is 3, CONVERGE Horizon will first request 5 nodes. If 5 nodes are not available, CONVERGE Horizon will request 4 nodes. If 4 nodes are not available, CONVERGE Horizon will request 3 nodes. If 3 nodes are not available, the cycle will be repeated, with sequential requests for 5 nodes, 4 nodes, and 3 nodes, until the requested number of nodes has been allocated or the Maximum Queue Time has elapsed.

Hardware > Minimum Number of Nodes¶

The minimum number of nodes that can be used to run the job if the Target Number of Nodes is not available. Applies only to node types that allow multiple nodes per job.

In rare scenarios, it is possible for a job to run with fewer than the minimum number of nodes. This occurs when a subset of the nodes that have been allocated and provisioned fail to authenticate with the cloud provider’s RoCE network (this authentication is typically the final step in the provisioning process). Instead of provisioning new nodes to replace the failed nodes—which would significantly increase the hardware cost of the job—CONVERGE Horizon will allow the job to run without the failed nodes.

Output¶

Output > Output File Compression¶

Determines whether output files will be compressed before they are uploaded to the space. Applies only if the job files are stored in a space. By default, the output files are not compressed.

System requirements for compressed output files are described in Extract Compressed Output Files.

Output > Exclude Output¶

Pattern(s) indicating which files should NOT be saved. Applies only if the job files are stored in a space. Files with paths matching the specified pattern(s) will not be uploaded to the output directory when the job is completed.

Use * to match any character in the file path. The pattern is compared to the entire file path, not just the file name. Multiple patterns can be specified as a comma-delimited list.

If you specify both this option and Include Output, included files are processed before excluded files. Leave both options blank to save all files.

Examples

*.h5
*.in,*.dat,*.cgns
*_preview*

Output > Include Output¶

Pattern(s) indicating which files to save. Applies only if the job files are stored in a space. Only the files with paths matching the specified pattern(s) will be uploaded to the output directory when the job is completed.

Use * to match any character in the file path. The pattern is compared to the entire file path, not just the file name. Multiple patterns can be specified as a comma-delimited list.

If you specify both this option and Exclude Output, included files are processed before excluded files. Leave both options blank to save all files.

Examples

*.out
*.out,*.h5
*outputs_*

Advanced Options¶

Advanced Options > Mode¶

The mode in which the job will run. In Automatic mode (default), CONVERGE runs automatically after the nodes are provisioned. In Interactive mode, CONVERGE is installed, but does not run automatically. You can SSH to the head node to run CONVERGE manually. Note the following:

The License option is ignored for interactive jobs. To run CONVERGE, you must complete the necessary environment setup after logging in to the head node, including the setup for connecting to your RLM license server. On-demand licensing is not available for interactive jobs.
If you run an interactive job from a space, your input and output files are not automatically copied to and from the cluster. After logging in to the head node, you can transfer files to and from the cluster with the space:download and space:upload commands.
Do not run applications that bind to ports 22, 80, or 443. These ports are used by CONVERGE Horizon.

Advanced Options > Stop If Stuck¶

By default, CONVERGE Horizon will automatically stop the job if it becomes stuck. A job is considered stuck if the simulation log has not been updated for over an hour, which typically indicates that the CONVERGE solver has become unresponsive and the simulation is no longer progressing.

If you do not want the job to be stopped automatically if it becomes stuck, uncheck Stop Job.

You also have the option to enable email notifications for stuck jobs, which are sent regardless of whether Stop Job is checked.

Advanced Options > Cores per Node¶

The number of cores that will be used to run the job on each node. Applies only to bare metal (BM) node types.

By default, CONVERGE Horizon uses a number of cores per node that has been optimized for the selected node type. Specify a number here only if you want to override the default value.

Advanced Options > Custom Commands to Run Instead of Default Snippet¶

The commands that will be executed instead of the default code snippet. Note that CONVERGE Horizon automatically redirects standard output to horizon.log, so you should not specify output redirection in your custom commands.

Warning

This option is intended only for expert users. Entering custom commands will override CONVERGE Horizon’s runtime environment, giving you complete control over what is executed on the allocated hardware. If you are not certain that the commands you entered are correct, it is likely that your job will fail. Your organization is responsible for the costs of any jobs that fail due to incorrect use of custom commands.