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

Feature 383 tcmpr doc test #441

Merged
merged 58 commits into from
May 7, 2024
Merged

Conversation

bikegeek
Copy link
Collaborator

@bikegeek bikegeek commented May 3, 2024

Pull Request Testing

  • Describe testing already performed for these changes:

    on host 'seneca':
    /d1/projects/TCMPR_TCDIAG

    generated multiple plot types within one config file and single plot type within one config file

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

  1. follow instructions in User's Guide:

https://metplotpy.readthedocs.io/en/feature_383_tcmpr_doc_test/Users_Guide/tcmpr_plots.html

Work in /d1/projects/TCMPR_TCDIAG and run the setup_env.bash script to set up the environments

  1. Set up:

Instructions based on working/testing on 'seneca'

  • clone the feature_383_tcmpr_doc_test branch of METplotpy

  • clone the develop branch of METcalcpy

    • if working on 'seneca', use this environment:

      /d1/personal/mwin/miniconda3/envs/mp_analysis_env

  1. Run the tests in $METPLOTPY/test/tcmpr_plots/
    pytest test_tcmpr_plots.py

  2. Using the config file under $METPLOTPY/test/tcmpr_plots/tcmpr_multi_plots.yaml
    set these to appropriate locations:

log_filename: '/path/to/log/output/tcmpr_log.out'
baseline_file: 'path/to/metplotpy/plots/tcmpr_plots/hfip_baseline.dat'
column_info_file: 'path/to/metplotpy/plots/tcmpr_plots/plot_tcmpr_hdr.dat'
tcst_dir: '/path/to/tcmpr_sample_data'

The baseline_file and column_info_file files are in the $METPLOTPY/metplotpy/plot/tcmpr_plots directory

  1. Generate the following plots:
    boxplot
    mean skill
    median skill
    relative performance
    mean
    median
    rank

python $METPLOTPY_BASE/metplotpy/plots/tcmpr_plots/tcmpr.py /path/to/tcmpr_multi_plots.yaml

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes ]

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

  • [?] Do these changes introduce new SonarQube findings? [Yes or No]

    If yes, please describe:

  • Please complete this pull request review by [At earliest convenience].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

…g one config file and logging to replace printing to stdout
… file, logging support added to replace print statements
…onfig file and logging to replace print statements
… file and logging to replace print statements
…onfig file and logging replaces printing to stdout
…ot types defined in a single config file. Also added logging
…ned in a single config file and added logging
bikegeek and others added 23 commits March 13, 2024 19:47
@bikegeek bikegeek requested a review from hankenstein2 May 3, 2024 23:40
set hfip_bsln.lower() to a variable
Copy link
Contributor

@hankenstein2 hankenstein2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran the tests on seneca, all plots appeared as expected and test passed

@hankenstein2 hankenstein2 merged commit 9e3e7af into develop May 7, 2024
7 checks passed
@hankenstein2 hankenstein2 deleted the feature_383_tcmpr_doc_test branch May 7, 2024 15:27
@jprestop jprestop linked an issue May 15, 2024 that may be closed by this pull request
23 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation and testing for TCMPR plotting code
2 participants