NOAA-EMC / UPP

Other
36 stars 98 forks source link

Update Namelist documentation for all namelist options #940

Closed christinaholtNOAA closed 4 months ago

christinaholtNOAA commented 5 months ago

Several UFS Apps use undocumented namelist settings in the UPP Read the Docs documentation. Specifically, I made these changes:

Fixes Issue #949

WenMeng-NOAA commented 5 months ago

@christinaholtNOAA Can you open a new UPP issue at here to link this PR?

WenMeng-NOAA commented 5 months ago

@christinaholtNOAA Can you sync your branch with the latest UPP develop?

christinaholtNOAA commented 5 months ago

Sorry I am falling behind on your requests. I will open the ticket, apply the suggested changes, and update the branch by tomorrow. Thanks for guiding me through the process.

christinaholtNOAA commented 5 months ago

@gspetro-NOAA, I am curious if you'd be okay with a standardized lowercase-only set of variables. Given that the capitalization strategy of these variables doesn't seem to have a rhyme or reason and that Fortran doesn't care, it seems like it might be more readable for users trying to get their namelists "right."

gspetro-NOAA commented 5 months ago

@christinaholtNOAA I think my main concern is just that the variables appear in the UPP code later in camel casing. I'm not sure what impact, if any, lowercasing things would have down the line. Lowercasing seems beneficial for uniformity and readability, but less expert users might be confused if later on they see camel-cased variables. So I can see plusses and minuses for both. @WenMeng-NOAA @FernandoAndrade-NOAA do you have any opinion?

FernandoAndrade-NOAA commented 5 months ago

@christinaholtNOAA I think my main concern is just that the variables appear in the UPP code later in camel casing. I'm not sure what impact, if any, lowercasing things would have down the line. Lowercasing seems beneficial for uniformity and readability, but less expert users might be confused if later on they see camel-cased variables. So I can see plusses and minuses for both. @WenMeng-NOAA @FernandoAndrade-NOAA do you have any opinion?

In the long run, I'd say uniformity and readability may be the bigger benefit than avoiding temporary confusion with users, even if I am partial to camel casing.

christinaholtNOAA commented 5 months ago

@WenMeng-NOAA Do you have any thoughts here? It seems like we might be leaning for uniformity to go with lower case in the docs, if you're in agreement.

WenMeng-NOAA commented 5 months ago

@WenMeng-NOAA Do you have any thoughts here? It seems like we might be leaning for uniformity to go with lower case in the docs, if you're in agreement.

@christinaholtNOAA Fortran coding is case insensitive. From documentation uniformity and readability perspective, using lower case would be good.

WenMeng-NOAA commented 4 months ago

@gspetro-NOAA We will wrap up this PR for testing. Please let us know if you have more comments.

WenMeng-NOAA commented 4 months ago

@FernandoAndrade-NOAA Conducting the UPP RTs on either Hera or Orion would be sufficient.

FernandoAndrade-NOAA commented 4 months ago

@FernandoAndrade-NOAA Conducting the UPP RTs on either Hera or Orion would be sufficient.

Hera RTs finished, this PR should be ready for merging.