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

Update RTD documentation for coupled components and workflow chart #3153

Open
DavidHuber-NOAA opened this issue Dec 11, 2024 · 0 comments
Open
Labels
feature New feature or request

Comments

@DavidHuber-NOAA
Copy link
Contributor

What new functionality do you need?

The ReadTheDocs documentation needs to be updated to include the following information:

  • Coupled components and how they are configured. The information should include supported grids, associated fix files, and procedures for updating staged ICs. This information is already available for the wave component, but it may make more sense to have individual sections for each discussion point (grids, fix files, procedures, others?) with subsections for each component.
  • The workflow chart and list of jobs needs to be updated to include all of the new GDASApp and associated coupled jobs as well as the recent reorganization of jobs. This chart and list of jobs are also dependent on the system (GFS, GEFS, and SFS), so there should be new pages generated for the newest two systems. It may be beneficial to write up a flow chart generation script in Python. There are a slew of packages available and having a program to generate the images would be much more efficient than redrawing the flowcharts by hand.

What are the requirements for the new functionality?

The documentation is up to date with current development.

Acceptance Criteria

  • Coupled component documentation is added for WW3, GOCART, MOM6, and CICE6
  • The existing flowchart is updated for ATM-only experiments
  • Additional flowcharts for GEFS and SFS are created
  • Job names and descriptions are updated

Suggest a solution (optional)

No response

@DavidHuber-NOAA DavidHuber-NOAA added feature New feature or request triage Issues that are triage labels Dec 11, 2024
@WalterKolczynski-NOAA WalterKolczynski-NOAA removed the triage Issues that are triage label Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants