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

Support various formats of show_legend values #482

Closed
24 tasks
bikegeek opened this issue Jan 9, 2025 · 1 comment · Fixed by #487
Closed
24 tasks

Support various formats of show_legend values #482

bikegeek opened this issue Jan 9, 2025 · 1 comment · Fixed by #487
Assignees
Labels
reporting: DTC NCAR Base NCAR Base DTC Project type: bug Fix something that is not working

Comments

@bikegeek
Copy link
Collaborator

bikegeek commented Jan 9, 2025

Describe the Problem

This is transferred from METviewer Issue #561

While attempting to generate series plots (line plots) using METviewer reusing existing XML config files, the legends are missing in 6.0 release. However, when generating these plots using METviewer 5.1 the legends are plotted. NOTE the show_legend setting was introduced into the METplotpy config files in the METplotpy 3.0/METviewer 6.0 coordinated release.

METviewer creates a YAML config file with show_legend values as strings-'1' vs 1. The METplotpy code is expecting a numerical value of 1 to show legend(s), with any other value for "do not show" legend(s). This is more readily fixed in the METplotpy code to ensure that command line users can use 1, or '1' or 'true'|'True', etc. This is why the issue was moved from METviewer to METplotpy.

Expected Behavior

Plot is generated using the YAML config file created by METviewer, but no legends are present.

Using the following data and yaml config file, the resulting plot has no legend:
plot_20250109_014251.data.txt
plot_20250109_014251.yaml.txt

plot_20250109_014251

Environment

Describe your runtime environment:
1. Machine: (e.g. HPC name, Linux Workstation, Mac Laptop)
2. OS: (e.g. RedHat Linux, MacOS)
3. Software version number(s)

To Reproduce

Describe the steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Post relevant sample data following these instructions:
https://dtcenter.org/community-code/model-evaluation-tools-met/met-help-desk#ftp

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

NCAR Base 2702701

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects###

  • Select Milestone as the next bugfix version
  • Select Coordinated METplus-X.Y Support project for support of the current coordinated release
  • Select METplotpy-X.Y.Z Development project for development toward the next official release

Define Related Issue(s)##

Consider the impact to the other METplus components.

Bugfix Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of main_<Version>.
    Branch name: bugfix_<Issue Number>_main_<Version>_<Description>
  • Fix the bug and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into main_<Version>.
    Pull request: bugfix <Issue Number> main_<Version> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next bugfix version
    Select: Coordinated METplus-X.Y Support project for support of the current coordinated release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Complete the steps above to fix the bug on the develop branch.
    Branch name: bugfix_<Issue Number>_develop_<Description>
    Pull request: bugfix <Issue Number> develop <Description>
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: METplotpy-X.Y.Z Development project for development toward the next official release
  • Close this issue.
@bikegeek bikegeek added type: bug Fix something that is not working alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Jan 9, 2025
@bikegeek
Copy link
Collaborator Author

METviewer is generating a YAML config file (that is used to generate the plot via METplotpy) with the show_legend setting to '1'. The METplotpy code expecting a numerical value of 1. Modifying the config.py to convert '1' and any variation of True (i.e. TRUE, true, etc) to numerical 1. This will provide better support for users who generate plots via command line.

@bikegeek bikegeek added this to the METplotpy-3.1.0 milestone Jan 24, 2025
bikegeek added a commit that referenced this issue Jan 24, 2025
@github-project-automation github-project-automation bot moved this to 🩺 Needs Triage in METplus-6.1.0 Development Jan 28, 2025
@bikegeek bikegeek linked a pull request Jan 29, 2025 that will close this issue
15 tasks
@michelleharrold michelleharrold added reporting: DTC NCAR Base NCAR Base DTC Project and removed alert: NEED ACCOUNT KEY Need to assign an account key to this issue alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED CYCLE ASSIGNMENT Need to assign to a release development cycle labels Jan 30, 2025
@michelleharrold michelleharrold moved this from 🩺 Needs Triage to 🏗 In progress in METplus-6.1.0 Development Jan 30, 2025
@michelleharrold michelleharrold moved this from 🏗 In progress to 🔎 In review in METplus-6.1.0 Development Jan 30, 2025
@jprestop jprestop changed the title support various formats of show_legend values Support various formats of show_legend values Jan 30, 2025
bikegeek added a commit that referenced this issue Jan 30, 2025
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-6.1.0 Development Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
reporting: DTC NCAR Base NCAR Base DTC Project type: bug Fix something that is not working
Projects
Status: 🏁 Done
Development

Successfully merging a pull request may close this issue.

2 participants