Skip to content

Commit e4cdb7f

Browse files
authored
Merge branch 'main' into CatalogBuilder-2025.01.01
2 parents aab24d4 + 13b3aa6 commit e4cdb7f

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

doc/generation.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,18 +208,33 @@ Refer to this `notebook <https://github.com/aradhakrishnanGFDL/canopy-cats/blob/
208208
Using FRE-CLI (GFDL only)
209209
-------------------------
210210

211-
Follow the `fre-cli setup documentation <https://noaa-gfdl.readthedocs.io/projects/fre-cli/en/latest/setup.html>`_ to gain access to fre-cli.
211+
**1. Setup FRE-CLI**
212+
Setup FRE-CLI through Lmod following `their setup documentation <https://noaa-gfdl.readthedocs.io/projects/fre-cli/en/latest/setup.html>`_.
212213

213-
Catalogs are generated by the following command: *fre catalog buildcatalog <INPUT_PATH> <OUTPUT_PATH>*
214+
.. code-block:: console
215+
216+
# find the most recent version of fre
217+
module avail fre
218+
# load the fre module. replace <NN> with the latest version
219+
module load fre/2025.<NN>
220+
221+
**2. Call the builder**
222+
223+
224+
Generate a catalog by running:
225+
226+
.. code-block:: console
227+
228+
fre catalog build $INPUT_PATH $OUTPUT_PATH
214229
215230
(OUTPUT_PATH should end with the desired output filename WITHOUT a file ending) See example below.
216231

217232
.. code-block:: console
218233
219-
fre catalog buildcatalog --overwrite /archive/path_to_data_dir ~/output
234+
fre catalog build --overwrite /archive/path_to_data_dir ~/output
220235
221236
222-
See `Flags`_ here.
237+
See `additional options here. <https://noaa-gfdl.github.io/CatalogBuilder/generation.html#arguments-options>`_
223238

224239
See `Fre-CLI Documentation here <https://noaa-gfdl.readthedocs.io/projects/fre-cli/en/latest/>`_
225240

0 commit comments

Comments
 (0)