Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add to readme description of what's in each directory #504

Closed
edwardhartnett opened this issue Sep 30, 2024 · 3 comments · Fixed by #506
Closed

add to readme description of what's in each directory #504

edwardhartnett opened this issue Sep 30, 2024 · 3 comments · Fixed by #506
Assignees
Labels
question Further information is requested

Comments

@edwardhartnett
Copy link
Contributor

For the readme, what are the contents of the different subdirectories:

  • ecf ?
  • fix - some data files?
  • jobs ?
  • modulefiles - module files for NOAA HPC systems
  • parm ?
  • scripts?
  • sorc ?
  • tests - unit tests for rrfs-workflow code
  • ush?
  • versions - shell scripts setting environment vars to the required versions of all dependencies, for building and for running rrfs-workflow.
@MatthewPyle-NOAA
Copy link
Contributor

Here are a few - will provide more background on a few more in a subsequent comment.

ecf - contains the ecFlow contents which will drive the RRFS workflow in NWS operations.

fix - contains static data

jobs - contains the main driver scripts (known as J-jobs) for each task. The workflow driver (either ecFlow or rocoto) submits these J-jobs,

parm - parameter files - generally namelists or configure files

@MatthewPyle-NOAA
Copy link
Contributor

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

ush - the utility scripts - scripts typically called by the "ex scripts" to handle specific tasks, often repeatedly for different times or geographic regions.

Want to bring in @BenjaminBlake-NOAA to see if he has any additional perspective to add. And can point you at the NCO implementation standard (https://www.nco.ncep.noaa.gov/idsb/implementation_standards/ImplementationStandards.v11.0.0.pdf) which describes most of these items in Table 3 on p. 19.

@BenjaminBlake-NOAA
Copy link
Contributor

Thanks @MatthewPyle-NOAA and @edwardhartnett . These descriptions sound pretty good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants