Skip to content

Commit

Permalink
Improve documentation per Kate's recommendation.
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgeGayno-NOAA committed Apr 26, 2023
1 parent 4694b22 commit 7279b73
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,12 @@ It also uses the following repositories:

On Orion, Jet, Hera and WCOSS2 do the following:

1) Set the 'fixed' directories using the 'link_fixdirs.sh'
script in ./fix. See the script's prolog for details.
1) Set the 'fixed' directories using the `link_fixdirs.sh`
script in `./fix`. Usage: `./link_fixdirs.sh $RUN_ENVIR $machine`,
where `$RUN_ENVIR` is "emc" or "nco" (most developers
should choose "emc") and `$machine` is the platform.

Example: `./link_fixdirs.sh emc hera`

2) This repository uses submodules, so do:

Expand Down
10 changes: 9 additions & 1 deletion fix/link_fixdirs.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
#!/bin/bash
set -ex

#--Make symbolic links to 'fixed' directories.
# Set up the 'fixed' directories.
#
# This script takes two arguments:
#
# $RUN_ENVIR - Either 'emc' (creates links) or
# 'nco' (copies data).
#
# $machine - is the machine. Choices are:
# 'wcoss2', 'hera', 'jet', 'orion', 's4'

RUN_ENVIR=${1}
machine=${2}
Expand Down

0 comments on commit 7279b73

Please sign in to comment.