scan (Command Line Interface)#

Scan dataset and return data information.

usage: restore-scan [-h] -i INPUT [-V] [-O OTHER] [-T] [-v]

required arguments#

-i

Input filename. This can be either the path to a local file or the URL to a remote dataset. The file or URL may or may not have a file extension. However, if the file does have an extension, the file extension should be either .nc, .nc4, .ncd, .nc.gz, .ncml, or *.ncml.gz only.

Named Arguments#

-V

Scans the velocity arrays in the file. This is useful to find the min and max range of the velocity data to adjust the color bar for plotting.

Default: False

-O

Scans other arrays in the file. This is useful to find the min and max range of the other arrays data to adjust the color bar for plotting. This argument should be comma-separated name of variables.

Default: “”

-T

If True, the program exists with code 1. This is useful when this package is executed on a server to pass exit signals to a Node application. On the downside, this option causes an interactive python environment to both terminate the script and the python environment itself. To avoid this, set this option to False. In this case, upon an error, the ValueError is raised, which cases the script to terminate, however, an interactive python environment will not be exited.

Default: False

Examples:

  1. Using a url on a remote machine. This will not scan the velocities. $ %s -T -i <url>

  2. Using a filename on the local machine. This will not scan the velocities $ %s -T -i <filename>

  3. Scan velocities form a url or filename: $ %s -T -V -i <url or filename>