Skip to content

Commit

Permalink
Improved the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Miguel R Zuniga authored and Miguel R Zuniga committed Dec 8, 2023
1 parent a834fd3 commit 3e1a76d
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,21 @@ The [Ocean Model Grid Generator](https://github.com/NOAA-GFDL/ocean_model_grid_g


### User Documentation
Documentation on using individual tools may be obtained by running
the tool without arguments or with the `-h` or `--help` options. Generally
this provides a list of the legal command line arguments, and frequently with
examples and explanations.
Documentation on using individual tools may be obtained by running the tool without
arguments or with the `-h` or `--help` options. Usually this provides a list of the
legal command line arguments, definitions of the arguments, a summary of the tool, and
examples.

Many of the tools are commonly used in conjunction with other tools or as part of a
workflow. The directory FRE-NCtools/t has numerous test scripts that exercise
some possible workflows. As an example, consider the script for CI test #3
(file Test03-grid_coupled_model.sh) for creating grids and mosaics for a coupled model.
As a second example, script Test20-fregrid.sh creates a target mosaic
(file latlon_grid.nc) and then uses fregrid to remap an existing file
(--input_file ocean_temp_salt.res.nc) of a known mosaic (CM2.1_mosaic.nc)
to the target mosaic.

Additional documentation may be found in the documentation directory
some possible workflows and can provide context for use of the tools. As an example,
consider the script for CI test #3 (file Test03-grid_coupled_model.sh) : via a detailed
example this script shows the use order of make_coupler_mosaic, make_solo_mosaic,
make_hgrid, make_vgrid and make_topog for creating grids and mosaics for a coupled
model. The docs directory contains a summary catalog of some of additional workflow
test scripts.

Additional documentation can be found in the documentation directory
( FRE-NCtools/docs ) and the
[FRE-NCTools wiki](https://github.com/NOAA-GFDL/FRE-NCtools/wiki/)

Expand Down

0 comments on commit 3e1a76d

Please sign in to comment.