Skip to content

Commit 57c5841

Browse files
committed
Fix: typo
1 parent ed36c9b commit 57c5841

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ will print a detailed usage message to the screen
4343
--product-type {esa-cci-oc,esa-scope-exchange,ghrsst,glorys}
4444
the product type. (default: None)
4545
--selector SELECTOR the Monte Carlo stream selector. An integral number
46-
whichmust not be negative. (default: None)
46+
which must not be negative. (default: None)
4747
--engine-reader {h5netcdf,netcdf4,zarr}
4848
specify the engine used to read the source product
4949
file. (default: None)
@@ -73,7 +73,40 @@ will print a detailed usage message to the screen
7373

7474
### Normal operations
7575

76-
TBD.
76+
To invoke the processor from the terminal, for instance, type
77+
78+
kaleidoscope --product-type ghrsst --selector 17 in.nc out.nc
79+
80+
which normally will log information to the terminal, e.g.,
81+
82+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] starting running processor
83+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: engine_reader = None
84+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: engine_writer = None
85+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: log_level = info
86+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: mode = multithreading
87+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: processor_name = kaleidoscope
88+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: processor_version = 2025.1.0
89+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: product_type = ghrsst
90+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: progress = False
91+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: selector = 17
92+
2025-04-30T09:42:11.928000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: source_file = in.nc
93+
2025-04-30T09:42:11.929000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: stack_traces = False
94+
2025-04-30T09:42:11.929000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: target_file = out.nc
95+
2025-04-30T09:42:11.929000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: tmpdir = .
96+
2025-04-30T09:42:11.929000Z <node> kaleidoscope 2025.1.0 [76069] [I] config: workers = 2
97+
2025-04-30T09:42:12.149000Z <node> kaleidoscope 2025.1.0 [76069] [I] starting creating processing graph
98+
2025-04-30T09:42:12.150000Z <node> kaleidoscope 2025.1.0 [76069] [I] starting graph for variable: analysed_sst
99+
2025-04-30T09:42:14.765000Z <node> kaleidoscope 2025.1.0 [76069] [I] finished graph for variable: analysed_sst
100+
2025-04-30T09:42:14.765000Z <node> kaleidoscope 2025.1.0 [76069] [I] finished creating processing graph
101+
2025-04-30T09:42:14.765000Z <node> kaleidoscope 2025.1.0 [76069] [I] starting writing target dataset: out.nc
102+
2025-04-30T09:42:20.637000Z <node> kaleidoscope 2025.1.0 [76069] [I] finished writing target dataset
103+
2025-04-30T09:42:20.638000Z <node> kaleidoscope 2025.1.0 [76069] [I] starting closing datasets
104+
2025-04-30T09:42:20.638000Z <node> kaleidoscope 2025.1.0 [76069] [I] finished closing datasets
105+
2025-04-30T09:42:20.638000Z <node> kaleidoscope 2025.1.0 [76069] [I] finished running processor
106+
2025-04-30T09:42:20.639000Z <node> kaleidoscope 2025.1.0 [76069] [I] elapsed time (seconds): 8.710
107+
108+
and eventually produce a forecast output dataset. Normally, the processor
109+
will terminate with an exit code of `0`.
77110

78111
### Error conditions
79112

0 commit comments

Comments
 (0)