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 #2690 tmp_files Contributor's Guide #2693

Merged
merged 10 commits into from
Sep 27, 2023

Conversation

JohnHalleyGotway
Copy link
Collaborator

@JohnHalleyGotway JohnHalleyGotway commented Sep 27, 2023

Expected Differences

Note that this PR is mainly for documentation changes. It describes MET's use of temporary files in the Contributor's Guide and adds relevant links between the User's Guide and Contributor's Guide. At the MET development meeting on 9/28/23, we'll discuss whether or not additional GitHub issues are warranted to refine MET's use of temporary files.

This PR also:

  • Removes the unused reference to tmp_dir from regrid_data_plane
  • Removes the unused tmp_dir option from the plot_point_obs configuration file/code

Note that I added a Contributor's Guide/dev_details directory rather than just a single dev_details.rst file. I anticipate that we'll want to add many development details, and it'll be convenient to organize the content across multiple .rst files rather than putting it all in one for the entire chapter.

  • Do these changes introduce new tools, command line arguments, or configuration file options? [No]

    If yes, please describe:

  • Do these changes modify the structure of existing or add new output data types (e.g. statistic line types or NetCDF variables)? [No]

    If yes, please describe:

Pull Request Testing

  • Describe testing already performed for these changes:

    Rendered and reviewed docs locally.

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

    Please review the proposed doc changes at https://met--2693.org.readthedocs.build/en/2693/

  • 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]
    None needed.

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

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

    No, although GHA testing workflow may continue to flag diffs related to PBL heights computed by PB2NC.

  • Please complete this pull request review by [Fri 9/29/23].

Pull Request Checklist

See the METplus Workflow for details.

  • 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) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or MET-X.Y.Z Development project for official releases
  • 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.

Copy link
Collaborator

@jprestop jprestop left a comment

Choose a reason for hiding this comment

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

I have reviewed the documentation changes and have ensured that all tests passed (noting that the failing check under Check for Differences in unrelated). I approve this request. Thank you for your work on this task.

@JohnHalleyGotway JohnHalleyGotway merged commit a45f5c8 into develop Sep 27, 2023
23 of 24 checks passed
@JohnHalleyGotway JohnHalleyGotway deleted the feature_2690_tmp_files branch September 27, 2023 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Document the use of temporary files in MET and reduce it as much as reasonably possible
2 participants