Skip to content

Commit

Permalink
Tweaking gen page
Browse files Browse the repository at this point in the history
  • Loading branch information
Ciheim Brown authored and Ciheim Brown committed Aug 27, 2024
1 parent ed1cd0c commit 0c8a075
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions doc/generation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Recommended approach: Install as a `conda package <https://anaconda.org/NOAA-GFD
conda install catalogbuilder -c noaa-gfdl
Alternatively, you may clone the `git repository <https://github.com/aradhakrishnanGFDL/CatalogBuilder.git>`_
and create your conda environment using the `environment.yml <https://github.com/aradhakrishnanGFDL/CatalogBuilder/blob/main/environment.yml>`_ in the git repository.
Alternatively, you may clone the `git repository <https://github.com/NOAA-GFDL/CatalogBuilder>`_
and create your conda environment using the `environment.yml <https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/environment.yml>`_ in the git repository.

.. code-block:: console
git clone https://github.com/aradhakrishnanGFDL/CatalogBuilder.git
git clone https://github.com/NOAA-GFDL/CatalogBuilder
conda env create -f environment_intake.yml
Expand Down Expand Up @@ -104,7 +104,7 @@ with the ESM collection specification standards and the appropriate workflows.
.. code-block:: yaml
#Directory structure information
output_path_template = ['NA','NA','source_id','NA','experiment_id','platform','custom_pp','modeling_realm','cell_methods','frequency','chunk_freq']
output_path_template = ['NA','NA','source_id','NA','experiment_id','platform','custom_pp','realm','cell_methods','frequency','chunk_freq']
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. We have NA in those values that do not match up with any of the expected headerlist (CSV columns), otherwise we
Expand All @@ -113,7 +113,7 @@ simply specify the associated header name in the appropriate place. E.g. The thi
.. code-block:: yaml
#Filename information
output_file_template = ['modeling_realm','temporal_subset','variable_id']
output_file_template = ['realm','temporal_subset','variable_id']
.. code-block:: yaml
Expand Down Expand Up @@ -146,7 +146,7 @@ Here is another example
From Jupyter Notebook
---------------------

Refer to this `notebook <https://github.com/aradhakrishnanGFDL/CatalogBuilder/blob/main/scripts/gen_intake_gfdl_notebook.ipynb>`_ to see how you can generate catalogs from a Jupyter Notebook
Refer to this `notebook <https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/scripts/gen_intake_gfdl_notebook.ipynb>`_ to see how you can generate catalogs from a Jupyter Notebook


.. image:: _static/catalog_generation.png
Expand Down Expand Up @@ -175,7 +175,7 @@ Catalogs are generated by the following command: *fre catalog buildcatalog <INPU
See `Flags`_ here.

See `Fre-CLI Documentation here <https://ciheim.github.io/fre-cli/>`_
See `Fre-CLI Documentation here <https://noaa-gfdl.github.io/fre-cli/>`_


Flags
Expand Down

0 comments on commit 0c8a075

Please sign in to comment.