From 6bf7ee9a3fdfe59b35e3a9162950dcfd26913257 Mon Sep 17 00:00:00 2001 From: Ed Date: Mon, 30 Sep 2024 13:25:53 -0600 Subject: [PATCH] more documentation in README about contents --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 1d4958c1..50e3e2d7 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,19 @@ The rrfs-workflow code is organized in the following subdirectories: * 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).