File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change @@ -6,12 +6,34 @@ The architecture of CSET.
6
6
Operators
7
7
---------
8
8
9
+ Operators provide the core functionality of CSET. Each operator is a function
10
+ that takes some input and returns some output, possibly also producing side
11
+ effects like saving plots.
12
+
13
+ All of the operators in CSET are contained in modules in
14
+ ``src/CSET/operators/ ``, which group related operators. For example ``plot.py ``
15
+ contains various plotting operators.
16
+
9
17
Recipes
10
18
-------
11
19
20
+ To produce a diagnostic, operators must be combined with recipes, which are YAML
21
+ files containing a graph of operators to execute, along with any needed
22
+ arguments and a bit of metadata.
23
+
24
+ The included recipes in CSET can be found in ``src/CSET/recipes/ ``.
25
+
26
+ A recipe may optionally contain variables, such as ``$VARIABLE ``, which is
27
+ replaced by a value provided on the command line or by a loader.
28
+
12
29
Loaders
13
30
-------
14
31
32
+ Loaders load recipes for use in the workflow, filling in any variables from the
33
+ configuration provided in the ``rose-suite.conf ``.
34
+
35
+ The included recipes in CSET can be found in ``src/CSET/recipes/loaders/ ``.
36
+
15
37
Workflow
16
38
--------
17
39
You can’t perform that action at this time.
0 commit comments