Workflow Automation documentation

Common Program options

Shared SIGCLEAR command-line controls for manuals, fields, threads, diagnostics and dataset history.

Common Program options

Control shared SIGCLEAR Program behavior

The SOIG runtime provides shared command-line controls for Programs in sigclear-soig and other processing packages that use libsoig. Options beginning with two hyphens control this shared behavior. Program-specific options remain documented in each Program manual.

OptionPurpose
--helpOpen the Program's installed manual and exit before processing input.
--default=VECTOR,...Select the default vectors processed by Programs that operate on dataset vectors.
--nthread=NSet the OpenMP thread count for Programs that support parallel processing.
--verb=y|nEnable or suppress processing and data-I/O progress messages.
--hist=append|ignore|clearAppend the current command to dataset history, preserve history without appending, or clear history.
--blksz=NSet the input file-buffer size in dataset columns. This advanced option can reduce memory use when reading datasets with large columns or groups.

For example, the following command fits only the pressure and altitude vectors and limits supported parallel work to four threads:

sgfit --default=pressure,altitude --nthread=4 \
    <observations.sg >prediction.sg
Exact option names

The thread option is --nthread, singular. These command-line options are separate from similarly named options accepted by the Python Process and Figure APIs.