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

Error in scripts/metadata2html.py #444

Closed
dustinswales opened this issue Mar 21, 2022 · 6 comments · Fixed by #445
Closed

Error in scripts/metadata2html.py #444

dustinswales opened this issue Mar 21, 2022 · 6 comments · Fixed by #445
Assignees
Labels
bug CCPP v6 Needed for CCPP v6 public release

Comments

@dustinswales
Copy link
Collaborator

dustinswales commented Mar 21, 2022

Description

In scripts/metadata2html.py, modules MetadataHeader is imported from metadata_table.py, but there is no MetadataHeader in metadata_table.py.

from metadata_table import MetadataHeader

An error occurs when referencing this module at L100:

metadata_headers = MetadataHeader.parse_metadata_file(filename_in)

parse_metadata_file is in metadata_table.py, but not contained within MetadataHeader.

Possibly replace
from metadata_table import MetadataHeader
With
from metadata_table import parse_metadata_file
But the function parse_metadata_file has a different interface...

@climbfuji
Copy link
Collaborator

That's interesting, I thought I tested the script when I merged the updates/bug fixes for mkdoc etc. Thanks for reporting, I'll take a look this week.

@ligiabernardet ligiabernardet added the CCPP v6 Needed for CCPP v6 public release label Mar 24, 2022
@climbfuji
Copy link
Collaborator

@dustinswales @ligiabernardet I had a look at this. Fixing the module imports and the call signature is easy, but the other problem is that the metadata_header to_html function was removed as part of the refactoring of the feature/capgen branch. I need to spend more time on the weekend to figure out if it got moved elsewhere or deleted, and if yes what the best approach is to get it back. I know we need it to create the scientific documentation for the CCPP v6 release, so this is high priority.

@dustinswales
Copy link
Collaborator Author

@ligiabernardet @mzhangw @climbfuji
I'm working on the RRTMGP documentation, but I cannot run the scripts to ensure what I'm doing isn't out to lunch. The syntax is pretty straightforward, so I'm sure that whatever I do will be close, but maybe not.
https://github.com/dustinswales/ccpp-physics/tree/add_gp_doxygen

@dustinswales
Copy link
Collaborator Author

dustinswales commented Apr 4, 2022

Also, I don't see that RRTMGP is included in the "P8C primary physics enhancements" in NCAR/ccpp-physics#877 (comment)

Dustin, the RRTMGP will definitely be part of p8c and, as such, of the p8 suite in CCPP.

@mzhangw
Copy link
Collaborator

mzhangw commented Apr 4, 2022

  • PR#445 from Dom should be good to create the metadata table. Please try it out.
  • RRTMGP, as well as Cellular Automata and unified UGWP, are considered "new" schemes, other than enhancements. We have contacted the new scheme developers separately:)

@climbfuji
Copy link
Collaborator

climbfuji commented Apr 4, 2022 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug CCPP v6 Needed for CCPP v6 public release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants