First version of metadata2html converter #208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…, not for type definitions/module variables
…pment work for generating html table from metadata table
…version of metadata-to-html converter
… to specified output directory
…nk metadata tables
climbfuji
changed the title
climbfuji
commented
Aug 15, 2019
llpcarson
approved these changes
Aug 16, 2019
grantfirl
reviewed
Aug 16, 2019
| help='directory where to write the html files', | ||
| required=True) | ||
|
|
||
| attributes = [ 'standard_name', 'long_name', 'units', 'local_name', |
There was a problem hiding this comment.
Which attributes should be displayed? I would argue not all of them in the scientific documentation. Maybe just standard_name, long_name, and units (intent might be useful too)?
There was a problem hiding this comment.
Correct. Something we need to iterate on with Ligia, Julie and Man as well. This script is a first version and I was hoping to improve it with the coming metadata conversions.
grantfirl
approved these changes
Aug 16, 2019
Thanks - any input for a better title? |
I was referring to your comment about the "My First HTML", which sounded like you were going to change it prior to this PR being merged. |
|
Argh. Of course. Battling with theia. First, disk quota exceeded (project stmp3), now refuses to accept data transfers. Will change the title. |
…table plus 'argument table', i.e. 'ozphys_run argument table'
Done - also tested this on my Mac. |
|
I agree that we do not need to display all attributes in the scientific
documentation. The proposal of standard_name, long_name, and units sounds
good. Intent may not be useful because that is parameterization-dependent,
so we may not be able to have this information in a generic list.
…On Fri, Aug 16, 2019 at 12:26 PM Dom Heinzeller ***@***.***> wrote:
Argh. Of course. Battling with theia. First, disk quota exceeded (project
stmp3), now refuses to accept data transfers. Will change the title.
Done - also tested this on my Mac.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#208?email_source=notifications&email_token=AE7WQATVD5U6ZKHRMHBSQ7TQE3WM7A5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PLN4I#issuecomment-522106609>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE7WQAX65TRUM7I6XT4GK43QE3WM7ANCNFSM4ILLECWA>
.
|
|
Regarding intent, I thought that this HTML converter was going to be used
for all individual parameterizations (replacing the metadata tables at the
start of each entry point). If someone was looking for how the
parameterization works, it might be good to know whether it modifies a
given variable with a quick looks at the docs.
On Fri, Aug 16, 2019 at 12:28 PM ligiabernardet <notifications@github.com>
wrote:
… I agree that we do not need to display all attributes in the scientific
documentation. The proposal of standard_name, long_name, and units sounds
good. Intent may not be useful because that is parameterization-dependent,
so we may not be able to have this information in a generic list.
On Fri, Aug 16, 2019 at 12:26 PM Dom Heinzeller ***@***.***>
wrote:
> Argh. Of course. Battling with theia. First, disk quota exceeded (project
> stmp3), now refuses to accept data transfers. Will change the title.
>
> Done - also tested this on my Mac.
>
> —
> You are receiving this because you are subscribed to this thread.
> Reply to this email directly, view it on GitHub
> <
#208?email_source=notifications&email_token=AE7WQATVD5U6ZKHRMHBSQ7TQE3WM7A5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PLN4I#issuecomment-522106609
>,
> or mute the thread
> <
https://github.com/notifications/unsubscribe-auth/AE7WQAX65TRUM7I6XT4GK43QE3WM7ANCNFSM4ILLECWA
>
> .
>
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#208?email_source=notifications&email_token=AGCO5UA5BZK6HZQEGLT4RR3QE3WVZA5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PLTTQ#issuecomment-522107342>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AGCO5UBYRVNBDGZJA27S22DQE3WVZANCNFSM4ILLECWA>
.
--
*Grant J. Firl*
Project Scientist I
Joint Numerical Testbed
Research Applications Laboratory
National Center for Atmospheric Research
FL3-1016: (303) 497-2872
|
|
OK. If we produce the HTML for each entry point subroutine, then indeed it
makes sense to have the intent be one of the displayed attributes.
…On Fri, Aug 16, 2019 at 12:34 PM grantfirl ***@***.***> wrote:
Regarding intent, I thought that this HTML converter was going to be used
for all individual parameterizations (replacing the metadata tables at the
start of each entry point). If someone was looking for how the
parameterization works, it might be good to know whether it modifies a
given variable with a quick looks at the docs.
On Fri, Aug 16, 2019 at 12:28 PM ligiabernardet ***@***.***>
wrote:
> I agree that we do not need to display all attributes in the scientific
> documentation. The proposal of standard_name, long_name, and units sounds
> good. Intent may not be useful because that is
parameterization-dependent,
> so we may not be able to have this information in a generic list.
>
> On Fri, Aug 16, 2019 at 12:26 PM Dom Heinzeller <
***@***.***>
> wrote:
>
> > Argh. Of course. Battling with theia. First, disk quota exceeded
(project
> > stmp3), now refuses to accept data transfers. Will change the title.
> >
> > Done - also tested this on my Mac.
> >
> > —
> > You are receiving this because you are subscribed to this thread.
> > Reply to this email directly, view it on GitHub
> > <
>
#208?email_source=notifications&email_token=AE7WQATVD5U6ZKHRMHBSQ7TQE3WM7A5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PLN4I#issuecomment-522106609
> >,
> > or mute the thread
> > <
>
https://github.com/notifications/unsubscribe-auth/AE7WQAX65TRUM7I6XT4GK43QE3WM7ANCNFSM4ILLECWA
> >
> > .
> >
>
> —
> You are receiving this because your review was requested.
> Reply to this email directly, view it on GitHub
> <
#208?email_source=notifications&email_token=AGCO5UA5BZK6HZQEGLT4RR3QE3WVZA5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PLTTQ#issuecomment-522107342
>,
> or mute the thread
> <
https://github.com/notifications/unsubscribe-auth/AGCO5UBYRVNBDGZJA27S22DQE3WVZANCNFSM4ILLECWA
>
> .
>
--
*Grant J. Firl*
Project Scientist I
Joint Numerical Testbed
Research Applications Laboratory
National Center for Atmospheric Research
FL3-1016: (303) 497-2872
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#208?email_source=notifications&email_token=AE7WQATVSVFLD2XA26WNZQTQE3XMLA5CNFSM4ILLECWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4PMCYI#issuecomment-522109281>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AE7WQAVVCXGGQ7PMJ3NAD5DQE3XMLANCNFSM4ILLECWA>
.
|
|
@gold2718 technically speaking we don't require reviews from non-DTC NCAR for commits going into ccpp-framework gmtb/develop, but please feel free to check and comment on how I implemented the metadata2html conversion tool. I will merge this PR now, hence any improvements/suggestions from your side will be going into a follow-up PR to gmtb/develop, so that whatever gets merged into master later is OK with you. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Associated PRs:
https://github.com/NCAR/NEMSfv3gfs/pull/212
NCAR/ccpp-physics#293
https://github.com/NCAR/FV3/pull/184
#208
NCAR/NEMS#1
For regression testing, see https://github.com/NCAR/NEMSfv3gfs/pull/212.
Changes in ccpp-framework:
metadata_headerclass and extending it with ato_htmlclass functionscripts/convert_metadata*.py: skip adding\htmlincludestatements for blank metadata tables