Skip to content

Commit ddb9ac4

Browse files
committed
Update: usage message
1 parent a1dcb73 commit ddb9ac4

File tree

1 file changed

+61
-1
lines changed

1 file changed

+61
-1
lines changed

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,67 @@ The processor is invoked from the command line. Typing
1818

1919
kaleidoscope --help
2020

21-
will print a detailed usage message to the screen.
21+
will print a detailed usage message to the screen
22+
23+
usage: kaleidoscope [-h] [--chunk-size-lat CHUNK_SIZE_LAT]
24+
[--chunk-size-lon CHUNK_SIZE_LON]
25+
[--engine-reader {h5netcdf,netcdf4,zarr}]
26+
[--engine-writer {h5netcdf,netcdf4,zarr}]
27+
[--log-level {debug,info,warning,error,off}]
28+
[--mode {multithreading,synchronous}]
29+
[--workers {1,2,3,4,5,6,7,8}] [--progress]
30+
[--no-progress] [--stack-traces] [--no-stack-traces]
31+
[--test] [--no-test] [--tmpdir TMPDIR] [-v]
32+
source_file target_file
33+
34+
This scientific processor simulates measurement errors.
35+
36+
positional arguments:
37+
source_file the file path of the source dataset.
38+
target_file the file path of the target dataset.
39+
40+
options:
41+
-h, --help show this help message and exit
42+
--chunk-size-lat CHUNK_SIZE_LAT
43+
specify the chunk size along the latitudinal
44+
dimension for reading and computing data arrays. A
45+
value of `-1` refers to full latitudinal chunk size
46+
and a value of `0` refers to the chunk size used in
47+
the source file. (default: None)
48+
--chunk-size-lon CHUNK_SIZE_LON
49+
specify the chunk size along the longitudinal
50+
dimension for reading and computing data arrays. A
51+
value of `-1` refers to full longitudinal chunk size
52+
and a value of `0` refers to the chunk size used in
53+
the source file. (default: None)
54+
--engine-reader {h5netcdf,netcdf4,zarr}
55+
specify the engine used to read the source product
56+
file. (default: None)
57+
--engine-writer {h5netcdf,netcdf4,zarr}
58+
specify the engine used to write the target product
59+
file. (default: None)
60+
--log-level {debug,info,warning,error,off}
61+
specify the log level. (default: None)
62+
--mode {multithreading,synchronous}
63+
specify the operating mode. In multithreading mode a
64+
multithreading scheduler is used. In synchronous
65+
mode a single-thread scheduler is used. (default:
66+
None)
67+
--workers {1,2,3,4,5,6,7,8}
68+
specify the number of workers used in multithreading
69+
mode. If not set, the number of workers is
70+
determined by the system. (default: None)
71+
--progress enable progress bar display. (default: False)
72+
--no-progress disable progress bar display. (default: True)
73+
--stack-traces enable Python stack traces. (default: False)
74+
--no-stack-traces disable Python stack traces. (default: True)
75+
--test enable test mode. (default: False)
76+
--no-test disable test mode. (default: True)
77+
--tmpdir TMPDIR specify the path to the temporary directory.
78+
(default: None)
79+
-v, --version show program's version number and exit
80+
81+
Copyright (c) Brockmann Consult GmbH, 2025. License: MIT
2282

2383
### Normal operations
2484

0 commit comments

Comments
 (0)