fred_scan

This reference page is not yet available.

Synopsis

usage: fred_scan --help | -k key -p program -v variable -o outvar --min min_val --max max_val [ -b params_base | -s -M ]
    -a : if set, prints out the results of each job associated with the scan.
    -b filename:  if set, a file containing parameters to include in each job
    -i value: the increment to be added to the changeable parameters (default = 0.1)
    -k key:   the key for a FRED job (required)
    -m int: the number of parallel jobs to run (default = 1)
    --max minval:  the upper bound for the changeable parameter (required)
    --min minval:  the lower bound for the changeable parameter (required)
    -n int: the total number of jobs to run (default = 1)
    -o outcome:  the FRED output variable for the outcome (required)
    -p program:  the main FRED program file (required)
    -s: if set, save each job (default => jobs are deleted)
    -v parameter:   the parameter variable. (required)
    -M: if set, the scan returns parameter with max outcome (default: return min outcome)

Description

This will be replaced with a command description

Options

-h

Print the usage message for this command.

-a

Option description, these will be in the same order as the usage message

-b

Option description, ending in a period.

Returns

This will describe the typical output or return value of the item, where applicable.

Examples

This will provide one or more examples for the command.

# some code

Environment

This will describe any key environment variables or other environmental settings that impact this item. If none, this will be deleted.

Errors

This will list the errors that may occur with this item. An exhaustive list is not required.

Notes

Any other notes related to this item, or remove this section. This might include:

  • The release this item was introduced. Use sentence “This <type> was introduced in release X.X”

  • Implementation notes such as complexity or resource utilization (such as memory).

  • Other important information as appropriate.

See Also

To be replaced with appropriate references, use the ref directive, as in

:ref:`fred_compile`

This produces the link fred_job, or just prints the name if the reference does not exist.