NCAR / ccpp-framework

Common Community Physics Package (CCPP)
http://www.dtcenter.org/community-code/common-community-physics-package-ccpp/
Other
26 stars 64 forks source link

Error in scripts/metadata2html.py #444

Closed dustinswales closed 2 years ago

dustinswales commented 2 years ago

Description

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

https://github.com/NCAR/ccpp-framework/blob/8577ea3b865a6ff7406c6d26c7dd3ce835b7c101/scripts/metadata2html.py#L12

An error occurs when referencing this module at L100: https://github.com/NCAR/ccpp-framework/blob/8577ea3b865a6ff7406c6d26c7dd3ce835b7c101/scripts/metadata2html.py#L100

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 commented 2 years ago

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.

climbfuji commented 2 years ago

@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 commented 2 years ago

@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 commented 2 years ago

Also, I don't see that RRTMGP is included in the "P8C primary physics enhancements" in https://github.com/NCAR/ccpp-physics/issues/877#issuecomment-1081404659

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

mzhangw commented 2 years ago
climbfuji commented 2 years ago

I have a PR in ccpp-framework that fixes metadata2html.py

On Apr 4, 2022, at 8:49 AM, dustinswales @.***> wrote:

@ligiabernardet https://github.com/ligiabernardet @mzhangw https://github.com/mzhangw Also, I don't see that RRTMGP is included in the "P8C primary physics enhancements" in NCAR/ccpp-physics#877 (comment) https://github.com/NCAR/ccpp-physics/issues/877#issuecomment-1081404659 — Reply to this email directly, view it on GitHub https://github.com/NCAR/ccpp-framework/issues/444#issuecomment-1087653696, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB5C2RJUVV24MTNNBDPUTGTVDL6PTANCNFSM5RIQQPDQ. You are receiving this because you were mentioned.