gmtb/develop: metadata2html batch processing#223
Conversation
…INTERNAL_VARIABLE_DEFINITON_FILE to common.py, correct typo
… on metadata2html.py
|
The This PR can be reviewed and merged anytime. |
|
@JulieSchramm @ligiabernardet I am not capable of generating the technical documentation, can someone let me know and/or test my changes to the tech doc? |
gold2718
left a comment
gold2718
left a comment
There was a problem hiding this comment.
Did not carefully review the HTML stuff but otherwise, it looks okay.
gold2718
left a comment
gold2718
left a comment
There was a problem hiding this comment.
Wrong radio button in my previous "comment".
|
|
||
| ./ccpp/framework/scripts/metadata2html.py -c ccpp/config/ccpp_prebuild_config.py | ||
|
|
||
| Note that the options ``-c`` and ``-m`` are mutually exclusive, but that one of them is required. Option ``-m`` also requires |
There was a problem hiding this comment.
I love argparse. Nice writeup of using the script.
| parser.add_argument('--outputdir', '-o', action='store', | ||
| help='directory where to write the html files', | ||
| required=True) | ||
| required='--metafile' in sys.argv or '-m' in sys.argv) |
There was a problem hiding this comment.
... Prof. Google ...
| else: | ||
| # DH* Warn for now, raise exception later when | ||
| # old metadata format is no longer supported | ||
| logger.warn("Metadata file {} for source file {} not found, assuming old metadata format".format( |
There was a problem hiding this comment.
The logic is that if something is still using the old metadata format, there is no need to generate a HTML table because it already exists in Doxygen-readable format, right?
3 participants
This PR adds a batch processing option to the Python script
metadata2html.py, which reads the host model's CCPP prebuild configuration and attempts to convert.metafiles for each of the schemes and variable definition files defined.For backward compatibility with the old metadata format, a warning is issued (instead of an exception) if the
.metacannot be found for a given file.The technical documentation is updated to reflect these changes.
This PR requires adding a new variable to the CCPP prebuild config, see PR https://github.com/NCAR/NEMSfv3gfs/pull/246. A similar PR for SCM will be created in the next days when all SCM metadata is converted to the new format.