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

Improve documentation of how POP (and MOM) generate diagnostics #405

Open
mnlevy1981 opened this issue May 16, 2022 · 1 comment
Open

Improve documentation of how POP (and MOM) generate diagnostics #405

mnlevy1981 opened this issue May 16, 2022 · 1 comment
Labels
Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/

Comments

@mnlevy1981
Copy link
Collaborator

Matt ran into an issue where he was providing POP with a tavg_contents_override_file file, but also putting ecosys_diagnostics in Source Mods -- I think the ecosys_diagnostics file was then used to generate the marbl_diagnostics_operators file, which resulted in an inconsistency between what diagnostics were being defined in POP and what was requested in tavg_contents.

We have documentation on how to add a new diagnostic but going in to more details in the POP implementation section would be helpful.

I want to draw a flow chart where each node is a file used in the process, and each connection is labeled with the name of the script that processes the file. Specifcally, it would start with diagnostics_latest.yaml and the edge connecting to diagnostics_latest.json would be labeled yaml_to_json.py. It would be helpful to highlight which files can be put in Source Mods, thus ignoring all the upstream files.

@mnlevy1981 mnlevy1981 added the Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/ label May 16, 2022
@mnlevy1981
Copy link
Collaborator Author

Related to this, I just had a discussion with @klindsay28 and think it would be useful to provide instructions on adding a new diagnostic entirely via SourceMods/, which would allow users to skip the "update the YAML file" step. The POP scripts will need to be updated first, though (see ESCOMP/POP2-CESM#71).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/
Projects
None yet
Development

No branches or pull requests

1 participant