Skip to content

Commit

Permalink
more documentation in README about contents (#506)
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhartnett authored Sep 30, 2024
1 parent 86e6c54 commit ff90de0
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,33 @@ Code Manager: Matthew Pyle
For more information see the [Team
Charter](https://docs.google.com/document/d/1uLbPx-pOWp7eECz_7VHRt_tQyD8PLFdrwo8dr4oMgjo/edit?usp=sharing).

## Contents

The rrfs-workflow code is organized in the following subdirectories:

* doc - the User Guide documentation.
* ecf - the ecFlow contents which will drive the RRFS workflow in NWS
operations.
* fix - static data.
* jobs - the main driver scripts (known as J-jobs) for each task. The
workflow driver (either ecFlow or rocoto) submits these J-jobs.
* modulefiles - module files for NOAA HPC systems.
* parm - parameter files - generally namelists or configure files.
* scripts - the "ex scripts" - the primary script for a given task,
and called by the J-job.
* sorc - all of the source codes that need to be built/compiled for
use within the package.
* tests - unit tests for rrfs-workflow code.
* ush - the utility scripts - scripts typically called by the "ex
scripts" to handle specific tasks, often repeatedly for different
times or geographic regions.
* versions - shell scripts setting environment vars to the required
versions of all dependencies, for building and for running
rrfs-workflow.

These are in compliance with the [NCO implementation standard]
(https://www.nco.ncep.noaa.gov/idsb/implementation_standards/ImplementationStandards.v11.0.0.pdf).

## Build Instructions

1. Clone the `main` branch of the authoritative repository:
Expand Down

0 comments on commit ff90de0

Please sign in to comment.