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 #2772 Apptainer documentation #2783

Merged
merged 6 commits into from
Nov 13, 2024

Conversation

georgemccabe
Copy link
Collaborator

@georgemccabe georgemccabe commented Nov 12, 2024

This PR also included a hotfix to change how quotation marks are added to plot_point_obs commands. Quotation marks are automatically applied for input files that are Python Embedding commands that contain spaces, so it is no longer necessary to add quotation marks in the PlotPointObs wrapper.

Pull Request Testing

  • Describe testing already performed for these changes:

Ran commands from new instructions on casper

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:
  • 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? [No]

    If yes, please describe:

  • Please complete this pull request review by 11/13/2024.

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • 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 METplus-Wrappers-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.

@georgemccabe georgemccabe added this to the METplus-6.0.0 milestone Nov 12, 2024
@georgemccabe georgemccabe linked an issue Nov 12, 2024 that may be closed by this pull request
24 tasks
@georgemccabe georgemccabe marked this pull request as ready for review November 12, 2024 21:16
Copy link
Contributor

@DanielAdriaansen DanielAdriaansen left a comment

Choose a reason for hiding this comment

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

I made some minor wording changes to the documentation, which I've suggested and request that @georgemccabe reviews and accepts those that you're in agreement with.

I followed the instructions on Casper, and was successful running the model_applications/pbl/PointStat_fcstHRRR_obsAMDAR_PBLH_PyEmbed.conf use case.

Thanks @georgemccabe, this will be a great addition!

docs/Users_Guide/getting_started.rst Outdated Show resolved Hide resolved
docs/Users_Guide/getting_started.rst Outdated Show resolved Hide resolved
docs/Users_Guide/getting_started.rst Outdated Show resolved Hide resolved
docs/Users_Guide/getting_started.rst Outdated Show resolved Hide resolved
docs/Users_Guide/getting_started.rst Show resolved Hide resolved
docs/Users_Guide/getting_started.rst Outdated Show resolved Hide resolved
georgemccabe and others added 4 commits November 13, 2024 12:07
…, so removing the 'disabled' item to run use case in GHA
…ython embedding commands as input file arguments handles quotes
@georgemccabe georgemccabe merged commit 5fadd22 into develop Nov 13, 2024
75 of 76 checks passed
@georgemccabe georgemccabe deleted the feature_2772_apptainer_docs branch November 13, 2024 21:33
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.

Documentation: Add instructions for running a use case using Apptainer
2 participants