From 475e328c027eb91004912dc718ab4eb679c8c93a Mon Sep 17 00:00:00 2001 From: Ciheim Brown Date: Tue, 1 Oct 2024 11:22:40 -0400 Subject: [PATCH] Adding catalog documentation --- docs/subtools.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/subtools.rst b/docs/subtools.rst index 900ea0e8..d4d6aafd 100644 --- a/docs/subtools.rst +++ b/docs/subtools.rst @@ -7,6 +7,29 @@ fre app fre catalog -------- +The fre catalog tool brings the functionality of the `GFDL catalog builder `_ to fre users. The catalog builder is a python community package ecosystem that allows you to generate data catalogs compatible with intake-esm. + +**Subtools** + +Buildcatalog - Generate a data catalog + +Validate - Validate the catalog + +**Flags** + +Overwrite - Overwrite an existing catalog at the given output path + +Apend - Append (without headerlist) to an existing catalog at the given output path + +**Quickstart** + +Catalogs are generated by the following command: fre catalog buildcatalog + +(OUTPUT_PATH should end with the desired output filename WITHOUT a file ending) See example below. + +.. code-block:: terminal +fre catalog buildcatalog --overwrite /archive/path_to_data_dir ~/output + fre check (not yet implemented) --------