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

Improve documentation on mapping METplus configuration items to MET config file env vars #402

Closed
Tracked by #681
DanielAdriaansen opened this issue Mar 20, 2020 · 4 comments
Assignees
Labels
component: documentation Documentation issue
Milestone

Comments

@DanielAdriaansen
Copy link
Contributor

DanielAdriaansen commented Mar 20, 2020

Add additional documentation, or re-work existing documentation that can help a user understand what environment variables are being set by METplus wrappers when a METplus conf item is set. George proposed putting this in the Python Wrappers section of the User's Guide. I also think the glossary could be updated to include the name of the environment variable set by the conf item, so as someone is "configuring" METplus and looking up items in the glossary there's a connection at that point for the user. @lisagoodrich may be able to help with the glossary work if that's the route we decide.

George also mentioned having a new DEBUG option that will print the METplus configuration items being used and the environment variables being set to logging somewhere.

@georgemccabe
Copy link
Collaborator

Consider creating a separate page to describe how each METplus config translates to the environment variable read by MET config files. We could link into this page from each use case doc and the Python Wrappers section of the User's Guide.

@DanielAdriaansen
Copy link
Contributor Author

@georgemccabe would you agree this was handled via #768 and can be closed?

@georgemccabe
Copy link
Collaborator

I think so. The additions you made to the Python Wrappers section cover how the METplus configs correspond to the environment variables used in the wrapped MET configs and the MET config variables that they control. I added logic to print a WARNING message if any of the supported METPLUS_ environment variables are not used in the user's wrapped MET config so they are aware that they can switch to using the wrapped configs in parm/met_config.

@DanielAdriaansen
Copy link
Contributor Author

Great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Documentation issue
Projects
None yet
Development

No branches or pull requests

4 participants