14 |
15 |
codacheck
16 |
17 |
This documentation describes the functionality of the codacheck tool which is part of CODA.
18 |
19 |
General description
20 |
21 |
The product format definitions in CODA should be of sufficient quality that whenever problems are detected while reading product files, it is usually the product files that are at fault. The codacheck program was written with this in mind. It uses CODA as an active product file problem-detection tool. It takes as arguments one or more product files. CODA will try to open each of these files and will actively look for any problems in these files. Any errors are reported in a user-readable way.
22 |
23 |
24 | codacheck [-D definitionpath] [<options>] <files>
25 | Provide a basic sanity check on product files supported by CODA
26 | Options:
27 | -d, --definition
28 | require products to have a definition in a codadef file,
29 | return an error and abort verification otherwise
30 | (affects products using formats such as xml/netcdf/hdf)
31 | -q, --quick
32 | only perform a quick check of the product
33 | (do not traverse the full product)
34 | -V, --verbose
35 | show more information while performing the check
36 |
37 | --no-mmap
38 | disable the use of mmap when opening files
39 |
40 | If you pass a '-' for the <files> section then the list of files will
41 | be read from stdin.
42 |
43 | codacheck -h, --help
44 | Show help (this text)
45 |
46 | codacheck -v, --version
47 | Print the version number of CODA and exit
48 |
49 | CODA will look for .codadef files using a definition path, which is a ':'
50 | separated (';' on Windows) list of paths to .codadef files and/or to
51 | directories containing .codadef files.
52 | By default the definition path is set to a single directory relative to
53 | the tool location. A different definition path can be set via the
54 | CODA_DEFINITION environment variable or via the -D option.
55 | (the -D option overrides the environment variable setting).
56 |
57 |
58 |
62 |
63 |
14 |
15 |
codacmp
16 |
17 |
This documentation describes the functionality of the codacmp tool which is part of CODA.
18 |
19 |
General description
20 |
21 |
With codacmp one can compare two product files. The tool is primarily intended for verification purposes.
22 |
23 |
24 | codacmp [-D definitionpath] [<options>] file1 file2
25 | Compare contents of file1 and file2
26 | Options:
27 | -d, --disable_conversions
28 | do not perform unit/value conversions
29 | -p, --path <path>
30 | path (in the form of a CODA node expression) to the
31 | location in the product where the comparison should begin.
32 | This path should be available in both products. If this
33 | parameter is not provided the full products are compared.
34 | -k, --key <path_to_array> <key_string_expr>
35 | for the given array in the product use the string
36 | expression as a unique key to line up the array elements in
37 | the two products. The array elements will then be compared
38 | as if it were record fields where the 'key' is used as the
39 | field name. This option can be provided multiple times (for
40 | different paths).
41 | -V, --verbose
42 | show more information while performing the comparison
43 |
44 | codacmp -h, --help
45 | Show help (this text)
46 |
47 | codacmp -v, --version
48 | Print the version number of CODA and exit
49 |
50 | CODA will look for .codadef files using a definition path, which is a ':'
51 | separated (';' on Windows) list of paths to .codadef files and/or to
52 | directories containing .codadef files.
53 | By default the definition path is set to a single directory relative to
54 | the tool location. A different definition path can be set via the
55 | CODA_DEFINITION environment variable or via the -D option.
56 | (the -D option overrides the environment variable setting).
57 |
58 |
59 |
63 |
64 |
14 |
15 |
codaeval
16 |
17 |
This documentation describes the functionality of the codaeval tool which is part of CODA.
18 |
19 |
General description
20 |
21 |
CODA contains an expression language that can be used to perform calculations on parameters inside a data product. The codaeval tool can be used to evaluate such an expression, either with on one or more product files or without (in case it is a constant expression). Alternatively, using the -c option, the tool will just verify if the expression is syntactically and grammatically correct.
22 |
23 |
24 | Usage:
25 | codaeval [-D definitionpath] [<options>] expression [<files|directories>]
26 | Evaluate a CODA expression on a series of files and/or recursively on
27 | all contents of directories
28 | If no files or directories are provided then codaeval should be a
29 | 'constant' expression (i.e. it may not contain node expressions or
30 | functions that rely on product content)
31 |
32 | Options:
33 | -c, --check
34 | only check the syntax of the expression, without evaluating
35 | it; any remaining options (including files) will be ignored
36 | -d, --disable_conversions
37 | do not perform unit/value conversions
38 | -p '<path>'
39 | a path (in the form of a CODA node expression) to the
40 | location in the product where the expression should be
41 | evaluated
42 | if no path is provided the expression will be evaluated
43 | at the root of the product
44 |
45 | A description of the syntax of CODA expression language can be found in the
46 | CODA documentation
47 |
48 | codaeval h, --help
49 | Show help (this text)
50 |
51 | codaeval -v, --version
52 | Print the version number of CODA and exit
53 |
54 | CODA will look for .codadef files using a definition path, which is a ':'
55 | separated (';' on Windows) list of paths to .codadef files and/or to
56 | directories containing .codadef files.
57 | By default the definition path is set to a single directory relative to
58 | the tool location. A different definition path can be set via the
59 | CODA_DEFINITION environment variable or via the -D option.
60 | (the -D option overrides the environment variable setting).
61 |
62 |
63 |
67 |
68 |
21 |
22 |
Ordering of elements within arrays (C or Fortran variant).
23 |
21 |
22 |
The data storage formats that are supported by CODA.
23 |
21 |
22 |
Machine specific data types.
23 |
25 |
26 |
This is the complete list of members for CodaException, including all inherited members.
27 |
28 |
29 |
Inherits Exception.
30 |
36 |
37 |
Exception indicating that an error occurred in the underlying CODA C Library.
38 |
39 |
40 |
◆ CodaException()
41 |
42 |
43 |
53 |
- Parameters
-
54 |
55 | | msg | An error message describing a CODA error. |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
21 |
Here is a list of all topics with brief descriptions:
32 |