Doc updates November

[aradhakrishnanGFDL]

Docs need to be verified and updated for the following,

Item 1: Notebooks and python script examples consistency checks

by cross-checking what I have in canopy-cats. Copy-paste the cells that actually are relevant to the building of catalogs along.. possibly the create_catalog(.....)

[one with config] (https://github.com/aradhakrishnanGFDL/canopy-cats/blob/main/notebooks/cm4_default.ipynb)
[one without config] (https://github.com/aradhakrishnanGFDL/canopy-cats/blob/main/notebooks/static_build_example.ipynb)

https://noaa-gfdl.github.io/CatalogBuilder/generation.html#from-a-python-script

https://noaa-gfdl.github.io/CatalogBuilder/generation.html#from-jupyter-notebook

Remove: https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/scripts/gen_intake_gfdl_notebook.ipynb

Add references to the notebooks in canopy-cats as part of docs. But, preferably copy over a good example to catalogbuilder to an appropriate place accessible by the conda package within catalogbuilder/

Item2 : Calling the builder as part of this https://noaa-gfdl.github.io/CatalogBuilder/generation.html#using-conda-package could use a snapshot of the Catalog builder help message or briefly display what command line args/opts are available and why. E.g --verbose, --slow, --config --merge AND how input and output paths can still be passed when one uses a config for the rest of the things.

It helps to organize this section outside of the conda package usage as it's relevant elsewhere too.

Item 3: Using FRE-CLI section needs major updates, especially to reflect --config option
(check if verbose option is in fre-cli, open issue on this separately if not)

Using FRE-CLI (GFDL only)¶

[aradhakrishnanGFDL]

@Ciheim based on today's meeting, the priority is to document --slow option for MDTF testing hand-off. Other prioritizations and planning based on what you see is important.
There was a note about fre-cli docs to be updated and simply add a hyperlink to the catalog builder to maintain one version of this doc