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.

Sign up for GitHub

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

Jump to bottom

Documentation: Add instructions for running a use case using Apptainer #2772

Closed
24 tasks
DanielAdriaansen opened this issue Nov 5, 2024 · 0 comments · Fixed by #2783
Closed
24 tasks

Documentation: Add instructions for running a use case using Apptainer #2772

DanielAdriaansen opened this issue Nov 5, 2024 · 0 comments · Fixed by #2783
Assignees
@georgemccabe
Labels
alert: NEED MORE DEFINITION Not yet actionable, additional definition required component: documentation Documentation issue reporting: NRL METplus Naval Research Laboratory METplus Project type: task An actionable item of work
Milestone
METplus-6.0.0

Comments

@DanielAdriaansen
Copy link
Contributor

DanielAdriaansen commented Nov 5, 2024 •
edited
Loading

Describe the Task

Providing instructions for users of Apptainer (formerly Singularity) on how to run existing METplus use cases using Apptainer would broaden our support capabilities to these users and also assist them with testing and running use cases in their environments. We should write the instructions for NCAR HPC (Casper).

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

This work must be completed by 30 Dec 2024

Funding Source

NRL METplus 7730022

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 a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

Task 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 develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development 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.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@DanielAdriaansen DanielAdriaansen added component: documentation Documentation issue type: task An actionable item of work alert: NEED MORE DEFINITION Not yet actionable, additional definition required reporting: NRL METplus Naval Research Laboratory METplus Project labels Nov 5, 2024
@DanielAdriaansen DanielAdriaansen added this to the METplus-6.1.0 milestone Nov 5, 2024
@github-project-automation github-project-automation bot moved this to 🩺 Needs Triage in MET-12.1.0 Development Nov 5, 2024
@DanielAdriaansen DanielAdriaansen moved this from 🩺 Needs Triage to 🟢 Ready in MET-12.1.0 Development Nov 5, 2024
@JohnHalleyGotway JohnHalleyGotway moved this from 🩺 Needs Triage to 🟢 Ready in METplus-Wrappers-6.1.0 Development Nov 5, 2024
georgemccabe added a commit that referenced this issue Nov 12, 2024
@georgemccabe
per #2772, added instructions to run a METplus use case using Apptainer
7bc3a3e
@georgemccabe georgemccabe linked a pull request Nov 12, 2024 that will close this issue
Feature #2772 Apptainer documentation #2783
Merged
16 tasks
@jprestop jprestop removed their assignment Nov 12, 2024
@georgemccabe georgemccabe moved this from 🟢 Ready to 🔎 In review in METplus-Wrappers-6.1.0 Development Nov 12, 2024
@georgemccabe georgemccabe moved this from 🩺 Needs Triage to 🔎 In review in METplus-Wrappers-6.0.0 Development Nov 12, 2024
georgemccabe added a commit that referenced this issue Nov 13, 2024
@georgemccabe @DanielAdriaansen
Feature #2772 Apptainer documentation (#2783)
5fadd22 
* update version of action to latest

* per #2772, added instructions to run a METplus use case using Apptainer

* Apply suggestions from code review

Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>

* bugfix dtcenter/MET#2899 prevents differences in output from use case, so removing the 'disabled' item to run use case in GHA

* hotfix: remove quotes around input files because logic that obtains python embedding commands as input file arguments handles quotes

* fix tests to match new expected commands

---------

Co-authored-by: Dan Adriaansen <dadriaan@ucar.edu>
@github-project-automation github-project-automation bot moved this from 🔎 In review to 🏁 Done in METplus-Wrappers-6.0.0 Development Nov 13, 2024
@georgemccabe georgemccabe changed the title Update METplus documentation to include instructions for running any existing use case using Apptainer Documentation: Add instructions for running a use case using Apptainer Nov 13, 2024
georgemccabe added a commit that referenced this issue Dec 6, 2024
@georgemccabe
to expand on #2772, updating instructions to include note to set tmp …
42355aa 
…directory for apptainer to prevent issues pulling large images that require a lot of temp space
georgemccabe added a commit that referenced this issue Dec 12, 2024
@georgemccabe
Feature #511 lists in command line single config overrides (#2815)
dc75ada 
* exclude metplus/scripts dir from PyCharm project to prevent incorrect duplicate code warnings with files that are sym linked

* to expand on #2772, updating instructions to include note to set tmp directory for apptainer to prevent issues pulling large images that require a lot of temp space

* per #511, add unit test for expected behavior to support comma-separated lists in a command line single config override that should fail until fix is made

* add a test to ensure that the -c argument is properly ignored since it is can be used in old use cases that were created when the argument was required

* per #511, add support for command line single config overrides to include values that are lists. Simplify logic to parse arguments to strip out -c/--config/-config arguments and skip check/error if argument is invalid because it is already handled in the metplus_config setup step that parses the arguments

* added unit test to ensure that an invalid command line argument causes the appropriate failure from run_metplus.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@georgemccabe georgemccabe

Labels
alert: NEED MORE DEFINITION Not yet actionable, additional definition required component: documentation Documentation issue reporting: NRL METplus Naval Research Laboratory METplus Project type: task An actionable item of work
Projects
No open projects
METplus-Wrappers-6.0.0 Development
Status: 🏁 Done
Milestone
METplus-6.0.0
Development

Successfully merging a pull request may close this issue.

Feature #2772 Apptainer documentation dtcenter/METplus
3 participants
@jprestop @DanielAdriaansen @georgemccabe