You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/generation.rst
+18-6Lines changed: 18 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,11 @@ A default configuration is used for catalog generation unless a custom configura
61
61
62
62
`Here <https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/tests/config-cfname.yaml>`_ is an example configuration file.
63
63
64
-
Catalog headers (column names) are set with the *HEADER LIST* variable. The *OUTPUT PATH TEMPLATE* variable controls the expected directory structure of input data.
64
+
65
+
**HEADERLIST**
66
+
67
+
Catalog headers (column names) are set with the *HEADER LIST* variable. The headerlist contains the expected column names of your catalog/csv file. This is usually determined by the users in conjuction
68
+
with the ESM collection specification standards and the appropriate workflows.
65
69
66
70
.. code-block:: yaml
67
71
@@ -71,8 +75,10 @@ Catalog headers (column names) are set with the *HEADER LIST* variable. The *OUT
The headerlist contains the expected column names of your catalog/csv file. This is usually determined by the users in conjuction
75
-
with the ESM collection specification standards and the appropriate workflows.
78
+
79
+
**OUTPUT PATH TEMPLATE**
80
+
81
+
The *OUTPUT PATH TEMPLATE* variable controls the expected directory structure of input data.
76
82
77
83
.. code-block:: yaml
78
84
@@ -82,20 +88,26 @@ with the ESM collection specification standards and the appropriate workflows.
82
88
For a directory structure like /archive/am5/am5/am5f3b1r0/c96L65_am5f3b1r0_pdclim1850F/gfdl.ncrc5-deploy-prod-openmp/pp the output_path_template is set as above.
83
89
84
90
We have NA in those values that do not match up with any of the expected headerlist (CSV columns), otherwise we
85
-
simply specify the associated header name in the appropriate place. E.g. The third directory in the PP path example above is the model (source_id), so the third list value in output_path_template is set to 'source_id'. We make sure this is a valid value in headerlist as well. The fourth directory is am5f3b1r0 which does not map to an existing header value. So we simply add NA in output_path_template for the fourth value.
91
+
simply specify the associated header name in the appropriate place. E.g. The third directory in the PP path example above is the model (source_id), so the third list value in output_path_template is set to 'source_id'. We make sure this is a valid value in headerlist as well. The fourth directory, 'am5f3b1r0', does not map to an existing header value so we simply add NA in output_path_template for the fourth value.
86
92
87
-
We have NA in values that do not match up with any of the expected headerlist (CSV columns), otherwise we simply specify the associated header name in the appropriate place. E.g. The third directory in the PP path example above is the model (source_id), so the third list value in output_path_template is set to 'source_id'. We make sure this is a valid value in headerlist as well.
93
+
**OUTPUT FILE TEMPLATE**
94
+
95
+
The *OUTPUT FILE TEMPLATE* variable controls the expected directory structure of the of input data. This is used to navigate within the post-processed (pp) directory where files are stored.
output_path: "/home/a1r/github/noaa-gfdl/catalogs/c96L65_am5f7b10r0_amip"# ENTER NAME OF THE CSV AND JSON, THE SUFFIX ALONE. This can be an absolute or a relative path
110
+
output_path: "/home/a1r/github/noaa-gfdl/catalogs/c96L65_am5f7b10r0_amip"# ENTER NAME OF THE CSV AND JSON, THE SUFFIX ALONE. This can be an absolute or a relative path.
0 commit comments